org.osid.resourcing

Interface EffortLookupSession

All Superinterfaces:

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

public interface EffortLookupSession
extends OsidSession

This session provides methods for retrieving Effort objects. The Effort represents a fixed connection between two Availabilities.

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
• isolated foundry view: All effort methods in this session operate, retrieve and pertain to efforts defined explicitly in the current foundry. Using an isolated view is useful for managing Efforts with the EffortAdminSession.
• federated foundry view: All effort methods in this session operate, retrieve and pertain to all efforts defined in this foundry and any other efforts implicitly available in this foundry through foundry inheritence.
• effective effort view: All effort lookup methods return efforts where the current date falls in between the effective dates inclusive.
• any effective effort view: Efforts of any effective date are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedFoundryView() and useIsolatedFoundryView() 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	canLookupEfforts() Tests if this user can perform Effort lookups.
Effort	getEffort(Id effortId) Gets the Effort specified by its Id.
EffortList	getEfforts() Gets all Efforts.
EffortList	getEffortsByGenusType(Type effortGenusType) Gets an EffortList corresponding to the given effort genus Type which does not include efforts of genus types derived from the specified Type.
EffortList	getEffortsByIds(IdList effortIds) Gets an EffortList corresponding to the given IdList.
EffortList	getEffortsByParentGenusType(Type effortGenusType) Gets an EffortList corresponding to the given effort genus Type and include any additional efforts with genus types derived from the specified Type.
EffortList	getEffortsByRecordType(Type effortRecordType) Gets an EffortList containing the given effort record Type.
EffortList	getEffortsForCommission(Id commissionId) Gets a list of efforts for a commission.
EffortList	getEffortsForCommissionOnDate(Id commissionId, DateTime from, DateTime to) Gets a list of efforts for a commission and effective during the entire given date range inclusive but not confined to the date range.
EffortList	getEffortsForResource(Id resourceId) Gets a list of efforts for a resource.
EffortList	getEffortsForResourceAndCommission(Id resourceId, Id commissionId) Gets a list of efforts for a resource and commission.
EffortList	getEffortsForResourceAndCommissionOnDate(Id resourceId, Id commissionId, DateTime from, DateTime to) Gets a list of efforts for a resource and commission and effective during the entire given date range inclusive but not confined to the date range.
EffortList	getEffortsForResourceAndWork(Id resourceId, Id workId) Gets a list of efforts for a resource and work.
EffortList	getEffortsForResourceAndWorkOnDate(Id resourceId, Id workId, DateTime from, DateTime to) Gets a list of efforts for a resource and work and effective during the entire given date range inclusive but not confined to the date range.
EffortList	getEffortsForResourceOnDate(Id resourceId, DateTime from, DateTime to) Gets a list of efforts for a resource and effective beginning in the date range.
EffortList	getEffortsForWork(Id workId) Gets a list of efforts for a work.
EffortList	getEffortsForWorkOnDate(Id workId, DateTime from, DateTime to) Gets a list of efforts for a work and effective during the entire given date range inclusive but not confined to the date range.
EffortList	getEffortsOnDate(DateTime from, DateTime to) Gets a list of efforts effective during the entire given date range inclusive but not confined to the date range.
Foundry	getFoundry() Gets the Foundry associated with this session.
Id	getFoundryId() Gets the Foundry Id associated with this session.
void	useAnyEffectiveEffortView() All efforts of any effective dates are returned by methods in this session.
void	useComparativeEffortView() 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	useEffectiveEffortView() Only efforts whose effective dates are current are returned by methods in this session.
void	useFederatedFoundryView() Federates the view for methods in this session.
void	useIsolatedFoundryView() Isolates the view for methods in this session.
void	usePlenaryEffortView() A complete view of the Effort 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

getFoundryId

Id getFoundryId()

Gets the Foundry Id associated with this session.

Returns:

the Foundry Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFoundry

Foundry getFoundry()
                   throws OperationFailedException,
                          PermissionDeniedException

Gets the Foundry associated with this session.

Returns:

the foundry

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupEfforts

boolean canLookupEfforts()

Tests if this user can perform Effort 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.

useComparativeEffortView

void useComparativeEffortView()

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.

usePlenaryEffortView

void usePlenaryEffortView()

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

useFederatedFoundryView

void useFederatedFoundryView()

Federates the view for methods in this session. A federated view will include efforts in foundries which are children of this foundry in the foundry hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedFoundryView

void useIsolatedFoundryView()

Isolates the view for methods in this session. An isolated view restricts lookups to this foundry only.

Compliance:

mandatory - This method is must be implemented.

useEffectiveEffortView

void useEffectiveEffortView()

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

Compliance:

mandatory - This method is must be implemented.

useAnyEffectiveEffortView

void useAnyEffectiveEffortView()

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

Compliance:

mandatory - This method is must be implemented.

getEffort

Effort getEffort(Id effortId)
                 throws NotFoundException,
                        OperationFailedException,
                        PermissionDeniedException

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

Parameters:

effortId - Id of the Effort

Returns:

the effort

Throws:

NotFoundException - effortId not found

NullArgumentException - effortId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getEffortsByIds

EffortList getEffortsByIds(IdList effortIds)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Gets an EffortList corresponding to the given IdList. In plenary mode, the returned list contains all of the efforts 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 Efforts may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, efforts are returned that are currently effective. In any effective mode, effective efforts and those currently expired are returned.

Parameters:

effortIds - the list of Ids to retrieve

Returns:

the returned Effort list

Throws:

NotFoundException - an Id was not found

NullArgumentException - effortIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEffortsByGenusType

EffortList getEffortsByGenusType(Type effortGenusType)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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

Parameters:

effortGenusType - an effort genus type

Returns:

the returned Effort list

Throws:

NullArgumentException - effortGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEffortsByParentGenusType

EffortList getEffortsByParentGenusType(Type effortGenusType)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

effortGenusType - an effort genus type

Returns:

the returned Effort list

Throws:

NullArgumentException - effortGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEffortsByRecordType

EffortList getEffortsByRecordType(Type effortRecordType)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

effortRecordType - an effort record type

Returns:

the returned Effort list

Throws:

NullArgumentException - effortRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEffortsOnDate

EffortList getEffortsOnDate(DateTime from,
                          DateTime to)
                            throws OperationFailedException,
                                   PermissionDeniedException

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

Parameters:

from - start of date range

to - end of date range

Returns:

the returned Effort list

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.

getEffortsForResource

EffortList getEffortsForResource(Id resourceId)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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

Parameters:

resourceId - a resource Id

Returns:

the returned Effort list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEffortsForResourceOnDate

EffortList getEffortsForResourceOnDate(Id resourceId,
                                     DateTime from,
                                     DateTime to)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets a list of efforts for a resource and effective beginning in the date range. Efforts are returned with a start effective date that falls between the requested dates inclusive. In plenary mode, the returned list contains all known efforts or an error results. Otherwise, the returned list may contain only those efforts that are accessible through this session. In effective mode, efforts are returned that are currently effective. In any effective mode, effective efforts and those currently expired are returned.

Parameters:

resourceId - a resource Id

from - start of date range

to - end of date range

Returns:

the returned Effort list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - resourceId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEffortsForCommission

EffortList getEffortsForCommission(Id commissionId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

commissionId - a commission Id

Returns:

the returned Effort list

Throws:

NullArgumentException - commissionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEffortsForCommissionOnDate

EffortList getEffortsForCommissionOnDate(Id commissionId,
                                       DateTime from,
                                       DateTime to)
                                         throws OperationFailedException,
                                                PermissionDeniedException

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

Parameters:

commissionId - a commision Id

from - start of date range

to - end of date range

Returns:

the returned Effort list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - commissionId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEffortsForResourceAndCommission

EffortList getEffortsForResourceAndCommission(Id resourceId,
                                            Id commissionId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

resourceId - a resource Id

commissionId - a commission Id

Returns:

the returned Effort list

Throws:

NullArgumentException - resourceId or commissionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEffortsForResourceAndCommissionOnDate

EffortList getEffortsForResourceAndCommissionOnDate(Id resourceId,
                                                  Id commissionId,
                                                  DateTime from,
                                                  DateTime to)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

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

Parameters:

resourceId - a resource Id

commissionId - a commission Id

from - start of date range

to - end of date range

Returns:

the returned Effort list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - resourceId, commissionId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEffortsForWork

EffortList getEffortsForWork(Id workId)
                             throws OperationFailedException,
                                    PermissionDeniedException

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

Parameters:

workId - a work Id

Returns:

the returned Effort list

Throws:

NullArgumentException - workId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEffortsForWorkOnDate

EffortList getEffortsForWorkOnDate(Id workId,
                                 DateTime from,
                                 DateTime to)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

workId - a work Id

from - start of date range

to - end of date range

Returns:

the returned Effort list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - workId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEffortsForResourceAndWork

EffortList getEffortsForResourceAndWork(Id resourceId,
                                      Id workId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

resourceId - a resource Id

workId - a work Id

Returns:

the returned Effort list

Throws:

NullArgumentException - resourceId or workId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEffortsForResourceAndWorkOnDate

EffortList getEffortsForResourceAndWorkOnDate(Id resourceId,
                                            Id workId,
                                            DateTime from,
                                            DateTime to)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

resourceId - a resource Id

workId - a work Id

from - start of date range

to - end of date range

Returns:

the returned Effort list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - resourceId, workId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEfforts

EffortList getEfforts()
                      throws OperationFailedException,
                             PermissionDeniedException

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

Returns:

a list of Efforts

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.