org.osid.personnel

Interface Organization

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidObject, Temporal

public interface Organization
extends OsidObject, Federateable, Temporal

An Organization.

Method Summary

Methods

Modifier and Type	Method and Description
DisplayText	getDisplayLabel() Gets the display label or code for this organization.
OrganizationRecord	getOrganizationRecord(Type organizationRecordType) Gets the record corresponding to the given Organization record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getDisplayLabel

DisplayText getDisplayLabel()

Gets the display label or code for this organization.

Returns:

the display label

Compliance:

mandatory - This method must be implemented.

getOrganizationRecord

OrganizationRecord getOrganizationRecord(Type organizationRecordType)
                                         throws OperationFailedException

Gets the record corresponding to the given Organization record Type. This method is used to retrieve an object implementing the requested record. The organizationRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(organizationRecordType) is true .

Parameters:

organizationRecordType - the type of organization record to retrieve

Returns:

the organization record

Throws:

NullArgumentException - organizationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(organizationRecordType) is false

Compliance:

mandatory - This method must be implemented.