org.osid.personnel

Interface OrganizationLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface OrganizationLookupSession
extends OsidSession

This session defines methods for retrieving organizations.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition
• isolated realm view: All organization methods in this session operate, retrieve and pertain to organizations defined explicitly in the current realm. Using an isolated view is useful for managing organizations with the OrganizationAdminSession.
• federated realm view: All organization lookup methods in this session operate, retrieve and pertain to all organizations defined in this realm and any other realms implicitly available in this realm through realm inheritence.
• effective organization view: All organization lookup methods return organizations where the current date falls in between the effective dates inclusive.
• any status organization view: Organizations of any effective date are returned from methods.

The methods useFederatedRealmView() and useIsolatedRealmView() behave as a radio group and one should be selected before invoking any lookup methods.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupOrganizations() Tests if this user can examine this realm.
Organization	getOrganization(Id organizationId) Gets the Organization specified by its Id.
OrganizationList	getOrganizations() Gets all organizations.
OrganizationList	getOrganizationsByGenusType(Type organizationGenusType) Gets an OrganizationList corresponding to the given organization genus Type which does not include organizations of types derived from the specified Type.
OrganizationList	getOrganizationsByIds(IdList organizationIds) Gets an OrganizationList corresponding to the given IdList.
OrganizationList	getOrganizationsByParentGenusType(Type organizationGenusType) Gets an OrganizationList corresponding to the given organization genus Type and include any additional organizations with genus types derived from the specified Type.
OrganizationList	getOrganizationsByRecordType(Type organizationRecordType) Gets an OrganizationList containing the given organization record Type.
OrganizationList	getOrganizationsOnDate(DateTime from, DateTime to) Gets an OrganizationList effective during the entire given date range inclusive but not confined to the date range.
Realm	getRealm() Gets the Realm associated with this session.
Id	getRealmId() Gets the Realm Id associated with this session.
void	useAnyEffectiveOrganizationView() All organizations of any effective dates are returned by methods in this session.
void	useComparativeOrganizationView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useEffectiveOrganizationView() Only organizations whose effective dates are current are returned by methods in this session.
void	useFederatedRealmView() Federates the view for methods in this session.
void	useIsolatedRealmView() Isolates the view for methods in this session.
void	usePlenaryOrganizationView() A complete view of the Organization returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getRealmId

Id getRealmId()

Gets the Realm Id associated with this session.

Returns:

the Realm Id associated with this session

Compliance:

mandatory - This method must be implemented.

getRealm

Realm getRealm()
               throws OperationFailedException,
                      PermissionDeniedException

Gets the Realm associated with this session.

Returns:

the realm

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupOrganizations

boolean canLookupOrganizations()

Tests if this user can examine this realm. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations.

Returns:

false if realm reading methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeOrganizationView

void useComparativeOrganizationView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryOrganizationView

void usePlenaryOrganizationView()

A complete view of the Organization returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

useFederatedRealmView

void useFederatedRealmView()

Federates the view for methods in this session. A federated view will include organizations in realms which are children of this realm in the realm hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedRealmView

void useIsolatedRealmView()

Isolates the view for methods in this session. An isolated view restricts retrievals to this realm only.

Compliance:

mandatory - This method is must be implemented.

useEffectiveOrganizationView

void useEffectiveOrganizationView()

Only organizations whose effective dates are current are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyEffectiveOrganizationView

void useAnyEffectiveOrganizationView()

All organizations of any effective dates are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getOrganization

Organization getOrganization(Id organizationId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Gets the Organization specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Organization may have a different Id than requested, such as the case where a duplicate Id was assigned to an Organization and retained for compatibility. In effective mode, organizations are returned that are currently effective. In any effective mode, effective organizations and those currently expired are returned.

Parameters:

organizationId - the Id of the Organization to retrieve

Returns:

the returned Organization

Throws:

NotFoundException - no Organization found with the given Id

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOrganizationsByIds

OrganizationList getOrganizationsByIds(IdList organizationIds)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Gets an OrganizationList corresponding to the given IdList. In plenary mode, the returned list contains all of the organizations specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible organizations may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, organizations are returned that are currently effective. In any effective mode, effective organizations and those currently expired are returned.

Parameters:

organizationIds - the list of Ids to retrieve

Returns:

the returned Organization list

Throws:

NotFoundException - an Id was not found

NullArgumentException - organizationIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOrganizationsByGenusType

OrganizationList getOrganizationsByGenusType(Type organizationGenusType)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Gets an OrganizationList corresponding to the given organization genus Type which does not include organizations of types derived from the specified Type. In plenary mode, the returned list contains all known organizations or an error results. Otherwise, the returned list may contain only those organizations that are accessible through this session. In effective mode, organizations are returned that are currently effective. In any effective mode, effective organizations and those currently expired are returned.

Parameters:

organizationGenusType - an organizations genus type

Returns:

the returned Organization list

Throws:

NullArgumentException - organizationGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOrganizationsByParentGenusType

OrganizationList getOrganizationsByParentGenusType(Type organizationGenusType)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Gets an OrganizationList corresponding to the given organization genus Type and include any additional organizations with genus types derived from the specified Type. In plenary mode, the returned list contains all known organizations or an error results. Otherwise, the returned list may contain only those organizations that are accessible through this session. In effective mode, organizations are returned that are currently effective. In any effective mode, effective organizations and those currently expired are returned.

Parameters:

organizationGenusType - an organization genus type

Returns:

the returned Organization list

Throws:

NullArgumentException - organizationGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOrganizationsByRecordType

OrganizationList getOrganizationsByRecordType(Type organizationRecordType)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets an OrganizationList containing the given organization record Type. In plenary mode, the returned list contains all known organizations or an error results. Otherwise, the returned list may contain only those organizations that are accessible through this session. In effective mode, organizations are returned that are currently effective. In any effective mode, effective organizations and those currently expired are returned.

Parameters:

organizationRecordType - an organization record type

Returns:

the returned OrganizationList

Throws:

NullArgumentException - organizationRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOrganizationsOnDate

OrganizationList getOrganizationsOnDate(DateTime from,
                                      DateTime to)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets an OrganizationList effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known organizations or an error results. Otherwise, the returned list may contain only those organizations that are accessible through this session. In effective mode, organizations are returned that are currently effective. In any effective mode, effective organizations and those currently expired are returned.

Parameters:

from - start of date range

to - end of date range

Returns:

the returned OrganizationList

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOrganizations

OrganizationList getOrganizations()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Gets all organizations. In plenary mode, the returned list contains all known organizations or an error results. Otherwise, the returned list may contain only those organizations that are accessible through this session. In effective mode, organizations are returned that are currently effective. In any effective mode, effective organizations and those currently expired are returned.

Returns:

a list of organizations

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.