org.osid.resourcing.rules

Interface JobConstrainerEnablerRuleLookupSession

All Superinterfaces:

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

public interface JobConstrainerEnablerRuleLookupSession
extends OsidSession

This session provides methods to retrieve JobConstrainerEnabler to JobConstrainer mappings. A JobConstrainer with multiple JobConstrainerEnablers means any positive rule evaluation across the enablers result in an effective JobConstrainer.

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 constrainer enablers defined explicitly in the current foundry
• federated foundry view: All 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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupJobConstrainerEnablerRules() Tests if this user can perform lookups of job constrainer enabler/job constrainer mappings.
Foundry	getFoundry() Gets the Foundry associated with this session.
Id	getFoundryId() Gets the Foundry Id associated with this session.
IdList	getJobConstrainerEnablerIdsForJobConstrainer(Id jobConstrainerId) Gets the JobConstrainerEnabler Id associated with a JobConstrainer.
JobConstrainerEnablerList	getJobConstrainerEnablersForJobConstrainer(Id jobConstrainerId) Gets the JobConstrainerEnablers associated with a JobConstrainer.
IdList	getJobConstrainerIdsForJobConstrainerEnabler(Id jobConstrainerEnablerId) Gets the JobConstrainer Ids mapped to a JobConstrainerEnabler.
JobConstrainerList	getJobConstrainersForJobConstrainerEnabler(Id jobConstrainerEnablerId) Gets the JobConstrainers mapped to a JobConstrainerEnabler.
void	useComparativeJobConstrainerEnablerRuleView() 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	usePlenaryJobConstrainerEnablerRuleView() A complete view of the JobConstrainerEnabler and JobConstrainer 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.

canLookupJobConstrainerEnablerRules

boolean canLookupJobConstrainerEnablerRules()

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

useComparativeJobConstrainerEnablerRuleView

void useComparativeJobConstrainerEnablerRuleView()

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.

usePlenaryJobConstrainerEnablerRuleView

void usePlenaryJobConstrainerEnablerRuleView()

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

getJobConstrainerEnablerIdsForJobConstrainer

IdList getJobConstrainerEnablerIdsForJobConstrainer(Id jobConstrainerId)
                                                    throws NotFoundException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Gets the JobConstrainerEnabler Id associated with a JobConstrainer.

Parameters:

jobConstrainerId - Id of the JobConstrainer

Returns:

the job constrainer enabler Ids

Throws:

NotFoundException - jobConstrainerId is not found

NullArgumentException - jobConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobConstrainerEnablersForJobConstrainer

JobConstrainerEnablerList getJobConstrainerEnablersForJobConstrainer(Id jobConstrainerId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException,
                                                                            PermissionDeniedException

Gets the JobConstrainerEnablers associated with a JobConstrainer.

Parameters:

jobConstrainerId - Id of the JobConstrainer

Returns:

the job constrainer enablers

Throws:

NotFoundException - jobConstrainerId is not found

NullArgumentException - jobConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobConstrainerIdsForJobConstrainerEnabler

IdList getJobConstrainerIdsForJobConstrainerEnabler(Id jobConstrainerEnablerId)
                                                    throws NotFoundException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Gets the JobConstrainer Ids mapped to a JobConstrainerEnabler.

Parameters:

jobConstrainerEnablerId - Id of a JobConstrainerEnabler

Returns:

list of job constrainer Ids

Throws:

NotFoundException - jobConstrainerEnablerId is not found

NullArgumentException - jobConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJobConstrainersForJobConstrainerEnabler

JobConstrainerList getJobConstrainersForJobConstrainerEnabler(Id jobConstrainerEnablerId)
                                                              throws NotFoundException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

Gets the JobConstrainers mapped to a JobConstrainerEnabler.

Parameters:

jobConstrainerEnablerId - Id of a JobConstrainerEnabler

Returns:

list of job constrainers

Throws:

NotFoundException - jobConstrainerEnablerId is not found

NullArgumentException - jobConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.