org.osid.workflow

Interface OfficeLookupSession

All Superinterfaces:

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

public interface OfficeLookupSession
extends OsidSession

This session provides methods for retrieving Office objects. The Office represents a collection of processes and steps.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Offices it can access, without breaking execution. However, an assessment may only be useful if all Offices referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupOffices() Tests if this user can perform Office lookups.
Office	getOffice(Id officeId) Gets the Office specified by its Id.
OfficeList	getOffices() Gets all Offices.
OfficeList	getOfficesByGenusType(Type officeGenusType) Gets an OfficeList corresponding to the given office genus Type which does not include offices of types derived from the specified Type.
OfficeList	getOfficesByIds(IdList officeIds) Gets an OfficeList corresponding to the given IdList.
OfficeList	getOfficesByParentGenusType(Type officeGenusType) Gets an OfficeList corresponding to the given office genus Type and include any additional offices with genus types derived from the specified Type.
OfficeList	getOfficesByProvider(Id resourceId) Gets an OfficeList from the given provider.
OfficeList	getOfficesByRecordType(Type officeRecordType) Gets an OfficeList containing the given office record Type.
void	useComparativeOfficeView() 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	usePlenaryOfficeView() A complete view of the Office 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

canLookupOffices

boolean canLookupOffices()

Tests if this user can perform Office lookups. 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 lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeOfficeView

void useComparativeOfficeView()

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.

usePlenaryOfficeView

void usePlenaryOfficeView()

A complete view of the Office 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.

getOffice

Office getOffice(Id officeId)
                 throws NotFoundException,
                        OperationFailedException,
                        PermissionDeniedException

Gets the Office specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Office may have a different Id than requested, such as the case where a duplicate Id was assigned to an Office and retained for compatibility.

Parameters:

officeId - Id of the Office

Returns:

the office

Throws:

NotFoundException - officeId not found

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getOfficesByIds

OfficeList getOfficesByIds(IdList officeIds)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Gets an OfficeList corresponding to the given IdList. In plenary mode, the returned list contains all of the offices 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 Offices may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

officeIds - the list of Ids to retrieve

Returns:

the returned Office list

Throws:

NotFoundException - an Id was not found

NullArgumentException - officeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficesByGenusType

OfficeList getOfficesByGenusType(Type officeGenusType)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets an OfficeList corresponding to the given office genus Type which does not include offices of types derived from the specified Type. In plenary mode, the returned list contains all known offices or an error results. Otherwise, the returned list may contain only those offices that are accessible through this session.

Parameters:

officeGenusType - an office genus type

Returns:

the returned Office list

Throws:

NullArgumentException - officeGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficesByParentGenusType

OfficeList getOfficesByParentGenusType(Type officeGenusType)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

officeGenusType - an office genus type

Returns:

the returned Office list

Throws:

NullArgumentException - officeGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficesByRecordType

OfficeList getOfficesByRecordType(Type officeRecordType)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Gets an OfficeList containing the given office record Type. In plenary mode, the returned list contains all known offices or an error results. Otherwise, the returned list may contain only those offices that are accessible through this session.

Parameters:

officeRecordType - an office record type

Returns:

the returned Office list

Throws:

NullArgumentException - officeRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficesByProvider

OfficeList getOfficesByProvider(Id resourceId)
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets an OfficeList from the given provider. In plenary mode, the returned list contains all known offices or an error results. Otherwise, the returned list may contain only those offices that are accessible through this session.

Parameters:

resourceId - a resource Id

Returns:

the returned Office list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOffices

OfficeList getOffices()
                      throws OperationFailedException,
                             PermissionDeniedException

Gets all Offices. In plenary mode, the returned list contains all known offices or an error results. Otherwise, the returned list may contain only those offices that are accessible through this session.

Returns:

a list of Offices

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.