org.osid.resourcing

Interface JobFoundrySession

All Superinterfaces:

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

public interface JobFoundrySession
extends OsidSession

This session provides methods to retrieve Job to Foundry resourcings. A Job may appear in multiple Foundry objects. Each foundry may have its own authorizations governing who is allowed to look at it.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupJobFoundryMappings() Tests if this user can perform lookups of job/foundry resourcings.
FoundryList	getFoundriesByJob(Id jobId) Gets the Foundries mapped to a Job.
IdList	getFoundryIdsByJob(Id jobId) Gets the Foundry Ids mapped to a Job.
IdList	getJobIdsByFoundries(IdList foundryIds) Gets the list of Job Ids corresponding to a list of Foundries.
IdList	getJobIdsByFoundry(Id foundryId) Gets the list of Job Ids associated with a Foundry.
JobList	getJobsByFoundries(IdList foundryIds) Gets the list of Job corresponding to a list of Foundries.
JobList	getJobsByFoundry(Id foundryId) Gets the list of Jobs associated with a Foundry.
void	useComparativeJobFoundryView() 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	usePlenaryJobFoundryView() A complete view of the Job and Foundry 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

canLookupJobFoundryMappings

boolean canLookupJobFoundryMappings()

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

useComparativeJobFoundryView

void useComparativeJobFoundryView()

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.

usePlenaryJobFoundryView

void usePlenaryJobFoundryView()

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

getJobIdsByFoundry

IdList getJobIdsByFoundry(Id foundryId)
                          throws NotFoundException,
                                 OperationFailedException,
                                 PermissionDeniedException

Gets the list of Job Ids associated with a Foundry.

Parameters:

foundryId - Id of the Foundry

Returns:

list of related job Ids

Throws:

NotFoundException - foundryId is not found

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobsByFoundry

JobList getJobsByFoundry(Id foundryId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Gets the list of Jobs associated with a Foundry.

Parameters:

foundryId - Id of the Foundry

Returns:

list of related jobs

Throws:

NotFoundException - foundryId is not found

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobIdsByFoundries

IdList getJobIdsByFoundries(IdList foundryIds)
                            throws OperationFailedException,
                                   PermissionDeniedException

Gets the list of Job Ids corresponding to a list of Foundries.

Parameters:

foundryIds - list of foundry Ids

Returns:

list of job Ids

Throws:

NullArgumentException - foundryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobsByFoundries

JobList getJobsByFoundries(IdList foundryIds)
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets the list of Job corresponding to a list of Foundries.

Parameters:

foundryIds - list of foundry Ids

Returns:

list of jobs

Throws:

NullArgumentException - foundryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFoundryIdsByJob

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

Gets the Foundry Ids mapped to a Job.

Parameters:

jobId - Id of a Job

Returns:

list of foundries

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.

getFoundriesByJob

FoundryList getFoundriesByJob(Id jobId)
                              throws NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Gets the Foundries mapped to a Job.

Parameters:

jobId - Id of a Job

Returns:

list of foundries

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.