org.osid.resourcing.rules

Interface JobProcessorRuleLookupSession

All Superinterfaces:

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

public interface JobProcessorRuleLookupSession
extends OsidSession

This session provides methods to retrieve JobProcessor to Job mappings.

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 defined explicitly in the current foundry
• federated foundry view: All methods in this session operate, retrieve and pertain to all job processor defined in this foundry and any other job processor implicitly available in this foundry through foundry inheritence.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupJobProcessorRules() Tests if this user can perform lookups of job processor/job mappings.
Foundry	getFoundry() Gets the Foundry associated with this session.
Id	getFoundryId() Gets the Foundry Id associated with this session.
IdList	getJobIdsForJobProcessor(Id jobProcessorId) Gets the Job Ids mapped to a JobProcessor.
IdList	getJobProcessorIdsForJob(Id jobId) Gets the JobProcessor Id associated with a Job.
JobProcessorList	getJobProcessorsForJob(Id jobId) Gets the JobProcessor associated with a Job.
JobList	getJobsForJobProcessor(Id jobProcessorId) Gets the Jobs mapped to a JobProcessor.
void	useComparativeJobProcessorRuleView() 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	usePlenaryJobProcessorRuleView() A complete view of the JobProcessor and Job 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.

canLookupJobProcessorRules

boolean canLookupJobProcessorRules()

Tests if this user can perform lookups of job processor/job 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.

useComparativeJobProcessorRuleView

void useComparativeJobProcessorRuleView()

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.

usePlenaryJobProcessorRuleView

void usePlenaryJobProcessorRuleView()

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

getJobProcessorIdsForJob

IdList getJobProcessorIdsForJob(Id jobId)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Gets the JobProcessor Id associated with a Job.

Parameters:

jobId - Id of the Job

Returns:

the job processor Ids

Throws:

NotFoundException - jobId is not found

NullArgumentException - jobId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobProcessorsForJob

JobProcessorList getJobProcessorsForJob(Id jobId)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Gets the JobProcessor associated with a Job.

Parameters:

jobId - Id of the Auction

Returns:

the job processors

Throws:

NotFoundException - jobId is not found

NullArgumentException - jobId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobIdsForJobProcessor

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

Gets the Job Ids mapped to a JobProcessor.

Parameters:

jobProcessorId - Id of a JobProcessor

Returns:

list of job 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.

getJobsForJobProcessor

JobList getJobsForJobProcessor(Id jobProcessorId)
                               throws NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Gets the Jobs mapped to a JobProcessor.

Parameters:

jobProcessorId - Id of a JobProcessor

Returns:

list of jobs

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.