org.osid.resourcing.rules

Interface JobProcessorEnablerRuleLookupSession

All Superinterfaces:

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

public interface JobProcessorEnablerRuleLookupSession
extends OsidSession

This session provides methods to retrieve JobProcessorEnabler to JobProcessor mappings. A JobProcessor with multiple JobProcessorEnablers means any positive rule evaluation across the enablers result in an effective JobProcessor.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition
• isolated foundry view: All methods in this session operate, retrieve and pertain job processor enablers defined explicitly in the current foundry
• federated foundry view: All 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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupJobProcessorEnablerRules() Tests if this user can perform lookups of job processor enabler/job processor mappings.
Foundry	getFoundry() Gets the Foundry associated with this session.
Id	getFoundryId() Gets the Foundry Id associated with this session.
IdList	getJobProcessorEnablerIdsForJobProcessor(Id jobProcessorId) Gets the JobProcessorEnabler Id associated with a JobProcessor.
JobProcessorEnablerList	getJobProcessorEnablersForJobProcessor(Id jobProcessorId) Gets the JobProcessorEnabler associated with a JobProcessor.
IdList	getJobProcessorIdsForJobProcessorEnabler(Id jobProcessorEnablerId) Gets the JobProcessor Ids mapped to a JobProcessorEnabler.
JobProcessorList	getJobProcessorsForJobProcessorEnabler(Id jobProcessorEnablerId) Gets the JobProcessors mapped to a JobProcessorEnabler.
void	useComparativeJobProcessorEnablerRuleView() 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	usePlenaryJobProcessorEnablerRuleView() A complete view of the JobProcessorEnabler and JobProcessor 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.

canLookupJobProcessorEnablerRules

boolean canLookupJobProcessorEnablerRules()

Tests if this user can perform lookups of job processor enabler/job processor mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeJobProcessorEnablerRuleView

void useComparativeJobProcessorEnablerRuleView()

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.

usePlenaryJobProcessorEnablerRuleView

void usePlenaryJobProcessorEnablerRuleView()

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

getJobProcessorEnablerIdsForJobProcessor

IdList getJobProcessorEnablerIdsForJobProcessor(Id jobProcessorId)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the JobProcessorEnabler Id associated with a JobProcessor.

Parameters:

jobProcessorId - Id of the JobProcessor

Returns:

the job processor enabler Ids

Throws:

NotFoundException - jobProcessorId is not found

NullArgumentException - jobProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobProcessorEnablersForJobProcessor

JobProcessorEnablerList getJobProcessorEnablersForJobProcessor(Id jobProcessorId)
                                                               throws NotFoundException,
                                                                      OperationFailedException,
                                                                      PermissionDeniedException

Gets the JobProcessorEnabler associated with a JobProcessor.

Parameters:

jobProcessorId - Id of the JobProcessor

Returns:

the job processor enablers

Throws:

NotFoundException - jobProcessorId is not found

NullArgumentException - jobProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobProcessorIdsForJobProcessorEnabler

IdList getJobProcessorIdsForJobProcessorEnabler(Id jobProcessorEnablerId)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the JobProcessor Ids mapped to a JobProcessorEnabler.

Parameters:

jobProcessorEnablerId - Id of a JobProcessorEnabler

Returns:

list of job processor Ids

Throws:

NotFoundException - jobProcessorEnablerId is not found

NullArgumentException - jobProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobProcessorsForJobProcessorEnabler

JobProcessorList getJobProcessorsForJobProcessorEnabler(Id jobProcessorEnablerId)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Gets the JobProcessors mapped to a JobProcessorEnabler.

Parameters:

jobProcessorEnablerId - Id of a JobProcessorEnabler

Returns:

list of job processors

Throws:

NotFoundException - jobProcessorEnablerId is not found

NullArgumentException - jobProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.