Interface StepProcessorEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface StepProcessorEnablerLookupSession
extends OsidSession

This session provides methods for retrieving StepProcessorEnablers .

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition
• isolated office view: All step processor enabler methods in this session operate, retrieve and pertain to step processor enablers defined explicitly in the current office. Using an isolated view is useful for managing StepProcessorEnablers with the StepProcessorEnablerAdminSession .
• federated office view: All step processor enabler methods in this session operate, retrieve and pertain to all step processor enablers defined in this office and any other step processor enablers implicitly available in this office through office inheritence.
• actuve step processor enabler view: All step processor enabler lookup methods return active step processor enablers.
• any stayus step processor enabler view: Step processor enablers of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedOfficeView() and useIsolatedOfficeView() behave as a radio group and one should be selected before invoking the methods in this session.

Method Summary

Modifier and Type	Method	Description
boolean	canLookupStepProcessorEnablers()	Tests if this user can perform StepProcessorEnablers lookups.
Office	getOffice()	Gets the Office associated with this session.
Id	getOfficeId()	Gets the Office Id associated with this session.
StepProcessorEnabler	getStepProcessorEnabler(Id stepProcessorEnablerId)	Gets the StepProcessorEnabler specified by its Id .
StepProcessorEnablerList	getStepProcessorEnablers()	Gets all StepProcessorEnablers .
StepProcessorEnablerList	getStepProcessorEnablersByGenusType(Type stepProcessorEnablerGenusType)	Gets a StepProcessorEnablerList corresponding to the given step processor enabler genus Type which does not include step processor enablers of genus types derived from the specified Type .
StepProcessorEnablerList	getStepProcessorEnablersByIds(IdList stepProcessorEnablerIds)	Gets a StepProcessorEnablerList corresponding to the given IdList .
StepProcessorEnablerList	getStepProcessorEnablersByParentGenusType(Type stepProcessorEnablerGenusType)	Gets a StepProcessorEnablerList corresponding to the given step processor enabler genus Type and include any additional step processor enablers with genus types derived from the specified Type .
StepProcessorEnablerList	getStepProcessorEnablersByRecordType(Type stepProcessorEnablerRecordType)	Gets a StepProcessorEnablerList containing the given step processor enabler record Type .
StepProcessorEnablerList	getStepProcessorEnablersOnDate(DateTime from, DateTime to)	Gets a StepProcessorEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent.
StepProcessorEnablerList	getStepProcessorEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to)	Gets a StepProcessorEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent.
void	useActiveStepProcessorEnablerView()	Only active step processor enablers are returned by methods in this session.
void	useAnyStatusStepProcessorEnablerView()	All active and inactive step processor enablers are returned by methods in this session.
void	useComparativeStepProcessorEnablerView()	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	useFederatedOfficeView()	Federates the view for methods in this session.
void	useIsolatedOfficeView()	Isolates the view for methods in this session.
void	usePlenaryStepProcessorEnablerView()	A complete view of the StepProcessorEnabler returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getOfficeId

Id getOfficeId()

Gets the Office Id associated with this session.

Returns:

the Office Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOffice

Office getOffice()
          throws OperationFailedException,
PermissionDeniedException

Gets the Office associated with this session.

Returns:

the office

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupStepProcessorEnablers

boolean canLookupStepProcessorEnablers()

Tests if this user can perform StepProcessorEnablers lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeStepProcessorEnablerView

void useComparativeStepProcessorEnablerView()

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.

usePlenaryStepProcessorEnablerView

void usePlenaryStepProcessorEnablerView()

A complete view of the StepProcessorEnabler 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.

useFederatedOfficeView

void useFederatedOfficeView()

Federates the view for methods in this session. A federated view will include step processor enablers in offices which are children of this office in the office hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedOfficeView

void useIsolatedOfficeView()

Isolates the view for methods in this session. An isolated view restricts lookups to this office only.

Compliance:

mandatory - This method is must be implemented.

useActiveStepProcessorEnablerView

void useActiveStepProcessorEnablerView()

Only active step processor enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusStepProcessorEnablerView

void useAnyStatusStepProcessorEnablerView()

All active and inactive step processor enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getStepProcessorEnabler

StepProcessorEnabler getStepProcessorEnabler(Id stepProcessorEnablerId)
                                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the StepProcessorEnabler specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned StepProcessorEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a StepProcessorEnabler and retained for compatibility. In active mode, step processor enablers are returned that are currently active. In any status mode, active and inactive step processors enablers are returned.

Parameters:

stepProcessorEnablerId - Id of the StepProcessorEnabler

Returns:

the step processor enabler

Throws:

NotFoundException - stepProcessorEnablerId not found

NullArgumentException - stepProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getStepProcessorEnablersByIds

StepProcessorEnablerList getStepProcessorEnablersByIds(IdList stepProcessorEnablerIds)
                                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a StepProcessorEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the step processor enablers specified in the Id list, in the order of the list, including duplicates, or an error results if a Id in the supplied list is not found or inaccessible. Otherwise, inaccessible StepProcessorEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, step processor enablers are returned that are currently active. In any status mode, active and inactive step processors enablers are returned.

Parameters:

stepProcessorEnablerIds - the list of Ids to retrieve

Returns:

the returned StepProcessorEnabler list

Throws:

NotFoundException - a Id was not found

NullArgumentException - stepProcessorEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStepProcessorEnablersByGenusType

StepProcessorEnablerList getStepProcessorEnablersByGenusType(Type stepProcessorEnablerGenusType)
                                                      throws OperationFailedException,
PermissionDeniedException

Gets a StepProcessorEnablerList corresponding to the given step processor enabler genus Type which does not include step processor enablers of genus types derived from the specified Type . In plenary mode, the returned list contains all known step processor enablers or an error results. Otherwise, the returned list may contain only those step processor enablers that are accessible through this session. In active mode, step processor enablers are returned that are currently active. In any status mode, active and inactive step processors enablers are returned.

Parameters:

stepProcessorEnablerGenusType - a step processor enabler genus type

Returns:

the returned StepProcessorEnabler list

Throws:

NullArgumentException - stepProcessorEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStepProcessorEnablersByParentGenusType

StepProcessorEnablerList getStepProcessorEnablersByParentGenusType(Type stepProcessorEnablerGenusType)
                                                            throws OperationFailedException,
PermissionDeniedException

Gets a StepProcessorEnablerList corresponding to the given step processor enabler genus Type and include any additional step processor enablers with genus types derived from the specified Type . In plenary mode, the returned list contains all known step processor enablers or an error results. Otherwise, the returned list may contain only those step processor enablers that are accessible through this session. In active mode, step processor enablers are returned that are currently active. In any status mode, active and inactive step processors enablers are returned.

Parameters:

stepProcessorEnablerGenusType - a step processor enabler genus type

Returns:

the returned StepProcessorEnabler list

Throws:

NullArgumentException - stepProcessorEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStepProcessorEnablersByRecordType

StepProcessorEnablerList getStepProcessorEnablersByRecordType(Type stepProcessorEnablerRecordType)
                                                       throws OperationFailedException,
PermissionDeniedException

Gets a StepProcessorEnablerList containing the given step processor enabler record Type . In plenary mode, the returned list contains all known step processor enablers or an error results. Otherwise, the returned list may contain only those step processor enablers that are accessible through this session. In active mode, step processor enablers are returned that are currently active. In any status mode, active and inactive step processors enablers are returned.

Parameters:

stepProcessorEnablerRecordType - a step processor enabler record type

Returns:

the returned StepProcessorEnabler list

Throws:

NullArgumentException - stepProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStepProcessorEnablersOnDate

StepProcessorEnablerList getStepProcessorEnablersOnDate(DateTime from,
 DateTime to)
                                                 throws OperationFailedException,
PermissionDeniedException

Gets a StepProcessorEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known step processor enablers or an error results. Otherwise, the returned list may contain only those step processor enablers that are accessible through this session. In active mode, step processor enablers are returned that are currently active. In any status mode, active and inactive step processors enablers are returned.

Parameters:

from - a start date

to - an end date

Returns:

the returned StepProcessorEnabler list

Throws:

InvalidArgumentException - from is greater tha to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStepProcessorEnablersOnDateWithAgent

StepProcessorEnablerList getStepProcessorEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                                          throws OperationFailedException,
PermissionDeniedException

Gets a StepProcessorEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known step processor enablers or an error results. Otherwise, the returned list may contain only those step processor enablers that are accessible through this session. In active mode, step processor enablers are returned that are currently active. In any status mode, active and inactive step processors enablers are returned.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned StepProcessorEnabler list

Throws:

InvalidArgumentException - from is greater tha to

NullArgumentException - agentId, from , or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStepProcessorEnablers

StepProcessorEnablerList getStepProcessorEnablers()
                                           throws OperationFailedException,
PermissionDeniedException

Gets all StepProcessorEnablers . In plenary mode, the returned list contains all known step processor enablers or an error results. Otherwise, the returned list may contain only those step processor enablers that are accessible through this session. In active mode, step processor enablers are returned that are currently active. In any status mode, active and inactive step processors enablers are returned.

Returns:

the returned StepProcessorEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.