org.osid.workflow.rules

Interface StepConstrainerEnablerOfficeSession

All Superinterfaces:

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

public interface StepConstrainerEnablerOfficeSession
extends OsidSession

This session provides methods to retrieve StepConstrainerEnabler to Office mappings. a StepConstrainerEnabler may appear in multiple Office objects. Each office 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	canLookupStepConstrainerEnablerOfficeMappings() Tests if this user can perform lookups of step constrainer enabler/office mappings.
IdList	getOfficeIdsByStepConstrainerEnabler(Id stepConstrainerEnablerId) Gets the Office Ids mapped to a StepConstrainerEnabler.
OfficeList	getOfficesByStepConstrainerEnabler(Id stepConstrainerEnablerId) Gets the Offices mapped to a StepConstrainerEnabler.
IdList	getStepConstrainerEnablerIdsByOffice(Id officeId) Gets the list of StepConstrainerEnablerIds associated with an Office.
IdList	getStepConstrainerEnablerIdsByOffices(IdList officeIds) Gets the list of StepConstrainerEnabler Ids corresponding to a list of Offices.
StepConstrainerEnablerList	getStepConstrainerEnablersByOffice(Id officeId) Gets the list of step constrainer enablers associated with an Office.
StepConstrainerEnablerList	getStepConstrainerEnablersByOffices(IdList officeIds) Gets the list of step constrainer enablers corresponding to a list of Offices.
void	useComparativeStepConstrainerEnablerOfficeView() 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	usePlenaryStepConstrainerEnablerOfficeView() A complete view of the StepConstrainerEnabler and Office 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

canLookupStepConstrainerEnablerOfficeMappings

boolean canLookupStepConstrainerEnablerOfficeMappings()

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

useComparativeStepConstrainerEnablerOfficeView

void useComparativeStepConstrainerEnablerOfficeView()

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.

usePlenaryStepConstrainerEnablerOfficeView

void usePlenaryStepConstrainerEnablerOfficeView()

A complete view of the StepConstrainerEnabler and Office 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.

getStepConstrainerEnablerIdsByOffice

IdList getStepConstrainerEnablerIdsByOffice(Id officeId)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Gets the list of StepConstrainerEnablerIds associated with an Office.

Parameters:

officeId - Id of the Office

Returns:

list of related step constrainer enabler Ids

Throws:

NotFoundException - officeId is not found

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStepConstrainerEnablersByOffice

StepConstrainerEnablerList getStepConstrainerEnablersByOffice(Id officeId)
                                                              throws NotFoundException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

Gets the list of step constrainer enablers associated with an Office.

Parameters:

officeId - Id of the Office

Returns:

list of related step constrainer enablers

Throws:

NotFoundException - officeId is not found

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStepConstrainerEnablerIdsByOffices

IdList getStepConstrainerEnablerIdsByOffices(IdList officeIds)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Gets the list of StepConstrainerEnabler Ids corresponding to a list of Offices.

Parameters:

officeIds - list of office Ids

Returns:

list of step constrainer enabler Ids

Throws:

NullArgumentException - officeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStepConstrainerEnablersByOffices

StepConstrainerEnablerList getStepConstrainerEnablersByOffices(IdList officeIds)
                                                               throws OperationFailedException,
                                                                      PermissionDeniedException

Gets the list of step constrainer enablers corresponding to a list of Offices.

Parameters:

officeIds - list of office Ids

Returns:

list of step constrainer enablers

Throws:

NullArgumentException - officeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficeIdsByStepConstrainerEnabler

IdList getOfficeIdsByStepConstrainerEnabler(Id stepConstrainerEnablerId)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Gets the Office Ids mapped to a StepConstrainerEnabler.

Parameters:

stepConstrainerEnablerId - Id of a StepConstrainerEnabler

Returns:

list of offices

Throws:

NotFoundException - stepConstrainerEnablerId is not found

NullArgumentException - stepConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficesByStepConstrainerEnabler

OfficeList getOfficesByStepConstrainerEnabler(Id stepConstrainerEnablerId)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Gets the Offices mapped to a StepConstrainerEnabler.

Parameters:

stepConstrainerEnablerId - Id of a StepConstrainerEnabler

Returns:

list of offices

Throws:

NotFoundException - stepConstrainerEnablerId is not found

NullArgumentException - stepConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.