Interface JobProcessorEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface JobProcessorEnablerLookupSession
extends OsidSession

This session provides methods for retrieving JobProcessorEnablers .

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 processor enabler methods in this session operate, retrieve and pertain to job processor enablers defined explicitly in the current foundry. Using an isolated view is useful for managing JobProcessorEnablers with the JobProcessorEnablerAdminSession .
• federated foundry view: All job processor enabler methods in this session operate, retrieve and pertain to all job processor enablers defined in this foundry and any other job processor enablers implicitly available in this foundry through foundry inheritence.
• active job processor enabler view: All job processor enabler lookup methods return active job processor enablers.
• any status job processor enabler view: Job processor 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	canLookupJobProcessorEnablers()	Tests if this user can perform JobProcessorEnablers lookups.
Foundry	getFoundry()	Gets the Foundry associated with this session.
Id	getFoundryId()	Gets the Foundry Id associated with this session.
JobProcessorEnabler	getJobProcessorEnabler(Id jobProcessorEnablerId)	Gets the JobProcessorEnabler specified by its Id .
JobProcessorEnablerList	getJobProcessorEnablers()	Gets all JobProcessorEnablers .
JobProcessorEnablerList	getJobProcessorEnablersByGenusType(Type jobProcessorEnablerGenusType)	Gets a JobProcessorEnablerList corresponding to the given job processor enabler genus Type which does not include job processor enablers of genus types derived from the specified Type .
JobProcessorEnablerList	getJobProcessorEnablersByIds(IdList jobProcessorEnablerIds)	Gets a JobProcessorEnablerList corresponding to the given IdList .
JobProcessorEnablerList	getJobProcessorEnablersByParentGenusType(Type jobProcessorEnablerGenusType)	Gets a JobProcessorEnablerList corresponding to the given job processor enabler genus Type and include any additional job processor enablers with genus types derived from the specified Type .
JobProcessorEnablerList	getJobProcessorEnablersByRecordType(Type jobProcessorEnablerRecordType)	Gets a JobProcessorEnablerList containing the given job processor enabler record Type .
JobProcessorEnablerList	getJobProcessorEnablersOnDate(DateTime from, DateTime to)	Gets a JobProcessorEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent.
JobProcessorEnablerList	getJobProcessorEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to)	Gets a JobProcessorEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent.
void	useActiveJobProcessorEnablerView()	Only active job processor enablers are returned by methods in this session.
void	useAnyStatusJobProcessorEnablerView()	All active and inactive job processor enablers are returned by methods in this session.
void	useComparativeJobProcessorEnablerView()	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	usePlenaryJobProcessorEnablerView()	A complete view of the JobProcessorEnabler 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.

canLookupJobProcessorEnablers

boolean canLookupJobProcessorEnablers()

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

useComparativeJobProcessorEnablerView

void useComparativeJobProcessorEnablerView()

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.

usePlenaryJobProcessorEnablerView

void usePlenaryJobProcessorEnablerView()

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

useActiveJobProcessorEnablerView

void useActiveJobProcessorEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

useAnyStatusJobProcessorEnablerView

void useAnyStatusJobProcessorEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

getJobProcessorEnabler

JobProcessorEnabler getJobProcessorEnabler(Id jobProcessorEnablerId)
                                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

jobProcessorEnablerId - Id of the JobProcessorEnabler

Returns:

the job processor enabler

Throws:

NotFoundException - jobProcessorEnablerId not found

NullArgumentException - jobProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getJobProcessorEnablersByIds

JobProcessorEnablerList getJobProcessorEnablersByIds(IdList jobProcessorEnablerIds)
                                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

jobProcessorEnablerIds - the list of Ids to retrieve

Returns:

the returned JobProcessorEnabler list

Throws:

NotFoundException - an Id was not found

NullArgumentException - jobProcessorEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobProcessorEnablersByGenusType

JobProcessorEnablerList getJobProcessorEnablersByGenusType(Type jobProcessorEnablerGenusType)
                                                    throws OperationFailedException,
PermissionDeniedException

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

Parameters:

jobProcessorEnablerGenusType - a job processor enabler genus type

Returns:

the returned JobProcessorEnabler list

Throws:

NullArgumentException - jobProcessorEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobProcessorEnablersByParentGenusType

JobProcessorEnablerList getJobProcessorEnablersByParentGenusType(Type jobProcessorEnablerGenusType)
                                                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

jobProcessorEnablerGenusType - a job processor enabler genus type

Returns:

the returned JobProcessorEnabler list

Throws:

NullArgumentException - jobProcessorEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobProcessorEnablersByRecordType

JobProcessorEnablerList getJobProcessorEnablersByRecordType(Type jobProcessorEnablerRecordType)
                                                     throws OperationFailedException,
PermissionDeniedException

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

Parameters:

jobProcessorEnablerRecordType - a job processor enabler record type

Returns:

the returned JobProcessorEnabler list

Throws:

NullArgumentException - jobProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobProcessorEnablersOnDate

JobProcessorEnablerList getJobProcessorEnablersOnDate(DateTime from,
 DateTime to)
                                               throws OperationFailedException,
PermissionDeniedException

Gets a JobProcessorEnablerList 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 processor enablers or an error results. Otherwise, the returned list may contain only those job processor enablers that are accessible through this session. In active mode, job processor enablers are returned that are currently active. In any status mode, active and inactive job processor enablers are returned.

Parameters:

from - a start date

to - an end date

Returns:

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

getJobProcessorEnablersOnDateWithAgent

JobProcessorEnablerList getJobProcessorEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                                        throws OperationFailedException,
PermissionDeniedException

Gets a JobProcessorEnablerList 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 processor enablers or an error results. Otherwise, the returned list may contain only those job processor enablers that are accessible through this session. In active mode, job processor enablers are returned that are currently active. In any status mode, active and inactive job processor enablers are returned.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

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

getJobProcessorEnablers

JobProcessorEnablerList getJobProcessorEnablers()
                                         throws OperationFailedException,
PermissionDeniedException

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

Returns:

the returned JobProcessorEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.