org.osid.resourcing.rules

Interface JobConstrainerLookupSession

All Superinterfaces:

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

public interface JobConstrainerLookupSession
extends OsidSession

This session provides methods for retrieving JobConstrainers.

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 job constrainer methods in this session operate, retrieve and pertain to job constrainer defined explicitly in the current foundry. Using an isolated view is useful for managing JobConstrainers with the JobConstrainerAdminSession.
• federated foundry view: All job constrainer methods in this session operate, retrieve and pertain to all job constrainer defined in this foundry and any other job constrainer implicitly available in this foundry through foundry inheritence.
• active job constrainer view: All job constrainer lookup methods return active job constrainers.
• any status authorization enabler view: Jon constrainers of any active or inactive status 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 the methods in this session.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupJobConstrainers() Tests if this user can perform JobConstrainers lookups.
Foundry	getFoundry() Gets the Foundry associated with this session.
Id	getFoundryId() Gets the Foundry Id associated with this session.
JobConstrainer	getJobConstrainer(Id jobConstrainerId) Gets the JobConstrainer specified by its Id.
JobConstrainerList	getJobConstrainers() Gets all JobConstrainers.
JobConstrainerList	getJobConstrainersByGenusType(Type jobConstrainerGenusType) Gets a JobConstrainerList corresponding to the given job constrainer genus Type which does not include job constrainer of genus types derived from the specified Type.
JobConstrainerList	getJobConstrainersByIds(IdList jobConstrainerIds) Gets a JobConstrainerList corresponding to the given IdList.
JobConstrainerList	getJobConstrainersByParentGenusType(Type jobConstrainerGenusType) Gets a JobConstrainerList corresponding to the given job constrainer genus Type and include any additional job constrainer with genus types derived from the specified Type.
JobConstrainerList	getJobConstrainersByRecordType(Type jobConstrainerRecordType) Gets a JobConstrainerList containing the given job constrainer record Type.
void	useActiveJobConstrainerView() Only active job constrainers are returned by methods in this session.
void	useAnyStatusJobConstrainerView() All active and inactive job constrainers are returned by methods in this session.
void	useComparativeJobConstrainerView() 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	useFederatedFoundryView() Federates the view for methods in this session.
void	useIsolatedFoundryView() Isolates the view for methods in this session.
void	usePlenaryJobConstrainerView() A complete view of the JobConstrainer 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.

canLookupJobConstrainers

boolean canLookupJobConstrainers()

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

useComparativeJobConstrainerView

void useComparativeJobConstrainerView()

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.

usePlenaryJobConstrainerView

void usePlenaryJobConstrainerView()

A complete view of the JobConstrainer 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 job constrainer 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.

useActiveJobConstrainerView

void useActiveJobConstrainerView()

Only active job constrainers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusJobConstrainerView

void useAnyStatusJobConstrainerView()

All active and inactive job constrainers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getJobConstrainer

JobConstrainer getJobConstrainer(Id jobConstrainerId)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Gets the JobConstrainer specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned JobConstrainer may have a different Id than requested, such as the case where a duplicate Id was assigned to a JobConstrainer and retained for compatibility. In active mode, job constrainers are returned that are currently active. In any status mode, active and inactive job constrainers are returned.

Parameters:

jobConstrainerId - Id of the JobConstrainer

Returns:

the job constrainer

Throws:

NotFoundException - jobConstrainerId not found

NullArgumentException - jobConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getJobConstrainersByIds

JobConstrainerList getJobConstrainersByIds(IdList jobConstrainerIds)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Gets a JobConstrainerList corresponding to the given IdList. In plenary mode, the returned list contains all of the job constrainer 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 JobConstrainers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, job constrainers are returned that are currently active. In any status mode, active and inactive job constrainers are returned.

Parameters:

jobConstrainerIds - the list of Ids to retrieve

Returns:

the returned JobConstrainer list

Throws:

NotFoundException - an Id was not found

NullArgumentException - jobConstrainerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobConstrainersByGenusType

JobConstrainerList getJobConstrainersByGenusType(Type jobConstrainerGenusType)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Gets a JobConstrainerList corresponding to the given job constrainer genus Type which does not include job constrainer of genus types derived from the specified Type. In plenary mode, the returned list contains all known job constrainer or an error results. Otherwise, the returned list may contain only those job constrainer that are accessible through this session. In active mode, job constrainers are returned that are currently active. In any status mode, active and inactive job constrainers are returned.

Parameters:

jobConstrainerGenusType - a job constrainer genus type

Returns:

the returned JobConstrainer list

Throws:

NullArgumentException - jobConstrainerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobConstrainersByParentGenusType

JobConstrainerList getJobConstrainersByParentGenusType(Type jobConstrainerGenusType)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

Gets a JobConstrainerList corresponding to the given job constrainer genus Type and include any additional job constrainer with genus types derived from the specified Type. In plenary mode, the returned list contains all known job constrainer or an error results. Otherwise, the returned list may contain only those job constrainer that are accessible through this session. In active mode, job constrainers are returned that are currently active. In any status mode, active and inactive job constrainers are returned.

Parameters:

jobConstrainerGenusType - a job constrainer genus type

Returns:

the returned JobConstrainer list

Throws:

NullArgumentException - jobConstrainerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobConstrainersByRecordType

JobConstrainerList getJobConstrainersByRecordType(Type jobConstrainerRecordType)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Gets a JobConstrainerList containing the given job constrainer record Type. In plenary mode, the returned list contains all known job constrainer or an error results. Otherwise, the returned list may contain only those job constrainer that are accessible through this session. In active mode, job constrainers are returned that are currently active. In any status mode, active and inactive job constrainers are returned.

Parameters:

jobConstrainerRecordType - a job constrainer record type

Returns:

the returned JobConstrainer list

Throws:

NullArgumentException - jobConstrainerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobConstrainers

JobConstrainerList getJobConstrainers()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets all JobConstrainers. In plenary mode, the returned list contains all known job constrainer or an error results. Otherwise, the returned list may contain only those job constrainer that are accessible through this session. In active mode, job constrainers are returned that are currently active. In any status mode, active and inactive job constrainers are returned.

Returns:

the returned JobConstrainer list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.