Office

All Superinterfaces:: Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Office extends OsidCatalog

An Office represents a collection of process.

Like all OsidObjects, Office is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Method Summary

Modifier and Type

Method

Description

OfficeRecord

getOfficeRecord(Type officeRecordType)

Gets the office record corresponding to the given Office record Type.This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable
getProperties, getPropertiesByRecordType

Methods inherited from interface Extensible
getRecordTypes, hasRecordType

Methods inherited from interface Identifiable
getId, isCurrent

Methods inherited from interface OsidObject
getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Details
- getOfficeRecord
  
  OfficeRecord getOfficeRecord(Type officeRecordType) throws OperationFailedException
  
  Gets the office record corresponding to the given Office record Type.This method is used to retrieve an object implementing the requested record. The officeRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(officeRecordType) is true.
  
  Parameters:
  
  officeRecordType - the type of office record to retrieve
  
  Returns:
  
  the office record
  
  Throws:
  
  NullArgumentException - officeRecordType is null
  
  OperationFailedException - unable to complete request
  
  UnsupportedException - hasRecordType(officeRecordType) is false
  
  Compliance:
  mandatory - This method must be implemented.