Interface JobConstrainerEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface JobConstrainerEnablerLookupSession
extends OsidSession

This session provides methods for retrieving JobConstrainerEnablers .

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

Modifier and Type	Method	Description
boolean	canLookupJobConstrainerEnablers()	Tests if this user can perform JobConstrainerEnablers lookups.
Foundry	getFoundry()	Gets the Foundry associated with this session.
Id	getFoundryId()	Gets the Foundry Id associated with this session.
JobConstrainerEnabler	getJobConstrainerEnabler(Id jobConstrainerEnablerId)	Gets the JobConstrainerEnabler specified by its Id .
JobConstrainerEnablerList	getJobConstrainerEnablers()	Gets all JobConstrainerEnablers .
JobConstrainerEnablerList	getJobConstrainerEnablersByGenusType(Type jobConstrainerEnablerGenusType)	Gets a JobConstrainerEnablerList corresponding to the given job constrainer enabler genus Type which does not include job constrainer enablers of genus types derived from the specified Type .
JobConstrainerEnablerList	getJobConstrainerEnablersByIds(IdList jobConstrainerEnablerIds)	Gets a JobConstrainerEnablerList corresponding to the given IdList .
JobConstrainerEnablerList	getJobConstrainerEnablersByParentGenusType(Type jobConstrainerEnablerGenusType)	Gets a JobConstrainerEnablerList corresponding to the given job constrainer enabler genus Type and include any additional job constrainer enablers with genus types derived from the specified Type .
JobConstrainerEnablerList	getJobConstrainerEnablersByRecordType(Type jobConstrainerEnablerRecordType)	Gets a JobConstrainerEnablerList containing the given job constrainer enabler record Type .
JobConstrainerEnablerList	getJobConstrainerEnablersOnDate(DateTime from, DateTime to)	Gets a JobConstrainerEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent.
JobConstrainerEnablerList	getJobConstrainerEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to)	Gets a JobConstrainerEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent.
void	useActiveJobConstrainerEnablerView()	Only active job constrainer enablers are returned by methods in this session.
void	useAnyStatusJobConstrainerEnablerView()	All active and inactive job constrainer enablers are returned by methods in this session.
void	useComparativeJobConstrainerEnablerView()	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	usePlenaryJobConstrainerEnablerView()	A complete view of the JobConstrainerEnabler returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.

canLookupJobConstrainerEnablers

boolean canLookupJobConstrainerEnablers()

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

useComparativeJobConstrainerEnablerView

void useComparativeJobConstrainerEnablerView()

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.

usePlenaryJobConstrainerEnablerView

void usePlenaryJobConstrainerEnablerView()

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

useActiveJobConstrainerEnablerView

void useActiveJobConstrainerEnablerView()

Only active job constrainer enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusJobConstrainerEnablerView

void useAnyStatusJobConstrainerEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

getJobConstrainerEnabler

JobConstrainerEnabler getJobConstrainerEnabler(Id jobConstrainerEnablerId)
                                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

jobConstrainerEnablerId - Id of the JobConstrainerEnabler

Returns:

the job constrainer enabler

Throws:

NotFoundException - jobConstrainerEnablerId not found

NullArgumentException - jobConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getJobConstrainerEnablersByIds

JobConstrainerEnablerList getJobConstrainerEnablersByIds(IdList jobConstrainerEnablerIds)
                                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

jobConstrainerEnablerIds - the list of Ids to retrieve

Returns:

the returned JobConstrainerEnabler list

Throws:

NotFoundException - an Id was not found

NullArgumentException - jobConstrainerEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobConstrainerEnablersByGenusType

JobConstrainerEnablerList getJobConstrainerEnablersByGenusType(Type jobConstrainerEnablerGenusType)
                                                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

jobConstrainerEnablerGenusType - a job constrainer enabler genus type

Returns:

the returned JobConstrainerEnabler list

Throws:

NullArgumentException - jobConstrainerEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobConstrainerEnablersByParentGenusType

JobConstrainerEnablerList getJobConstrainerEnablersByParentGenusType(Type jobConstrainerEnablerGenusType)
                                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

jobConstrainerEnablerGenusType - a job constrainer enabler genus type

Returns:

the returned JobConstrainerEnabler list

Throws:

NullArgumentException - jobConstrainerEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobConstrainerEnablersByRecordType

JobConstrainerEnablerList getJobConstrainerEnablersByRecordType(Type jobConstrainerEnablerRecordType)
                                                         throws OperationFailedException,
PermissionDeniedException

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

Parameters:

jobConstrainerEnablerRecordType - a job constrainer enabler record type

Returns:

the returned JobConstrainerEnabler list

Throws:

NullArgumentException - jobConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobConstrainerEnablersOnDate

JobConstrainerEnablerList getJobConstrainerEnablersOnDate(DateTime from,
 DateTime to)
                                                   throws OperationFailedException,
PermissionDeniedException

Gets a JobConstrainerEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known job constrainer enablers or an error results. Otherwise, the returned list may contain only those job constrainer enablers that are accessible through this session. In active mode, job constrainer enablers are returned that are currently active. In any status mode, active and inactive job constrainer enablers are returned.

Parameters:

from - a start date

to - an end date

Returns:

the returned JobConstrainerEnabler 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.

getJobConstrainerEnablersOnDateWithAgent

JobConstrainerEnablerList getJobConstrainerEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                                            throws OperationFailedException,
PermissionDeniedException

Gets a JobConstrainerEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known job constrainer enablers or an error results. Otherwise, the returned list may contain only those job constrainer enablers that are accessible through this session. In active mode, job constrainer enablers are returned that are currently active. In any status mode, active and inactive job constrainer enablers are returned.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned JobConstrainerEnabler list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - agentId, from , or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobConstrainerEnablers

JobConstrainerEnablerList getJobConstrainerEnablers()
                                             throws OperationFailedException,
PermissionDeniedException

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

Returns:

the returned JobConstrainerEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.