Interface RuleAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface RuleAdminSession
extends OsidSession

This session creates, updates, and deletes Rules . The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Rule , a RuleForm is requested using getRuleFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned RuleForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the RuleForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each RuleForm corresponds to an attempted transaction.

For updates, RuleForms are requested to the Rule Id that is to be updated using getRuleFormForUpdate() . Similarly, the RuleForm has metadata about the data that can be updated and it can perform validation before submitting the update. The RuleForm can only be used once for a successful update and cannot be reused.

The delete operations delete Rules . To unmap a Rule from the current Engine , the RuleEngineAssignmentSession should be used. These delete operations attempt to remove the Rule itself thus removing it from all known Engine catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

Method Summary

Modifier and Type	Method	Description
void	aliasRule(Id ruleId, Id aliasId)	Adds an Id to a Rule for the purpose of creating compatibility.
boolean	canCreateRules()	Tests if this user can create Rules .
boolean	canCreateRuleWithRecordTypes(Type[] ruleRecordTypes)	Tests if this user can create a single Rule using the desired record types.
boolean	canDeleteRules()	Tests if this user can delete Rules .
boolean	canManageRuleAliases()	Tests if this user can manage Id aliases for Rules .
boolean	canUpdateRules()	Tests if this user can update Rules .
Rule	createRule(RuleForm ruleForm)	Creates a new Rule .
void	deleteRule(Id ruleId)	Deletes the Rule identified by the given Id .
Engine	getEngine()	Gets the Engine associated with this session.
Id	getEngineId()	Gets the Engine Id associated with this session.
RuleForm	getRuleFormForCreate(Type[] ruleRecordTypes)	Gets the rule form for creating new rules.
RuleForm	getRuleFormForUpdate(Id ruleId)	Gets the rule form for updating an existing rule.
void	updateRule(RuleForm ruleForm)	Updates an existing rule.

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

getEngineId

Id getEngineId()

Gets the Engine Id associated with this session.

Returns:

the Engine Id associated with this session

Compliance:

mandatory - This method must be implemented.

getEngine

Engine getEngine()
          throws OperationFailedException,
PermissionDeniedException

Gets the Engine associated with this session.

Returns:

the Engine associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreateRules

boolean canCreateRules()

Tests if this user can create Rules . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a Rule will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returns:

false if Rule creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateRuleWithRecordTypes

boolean canCreateRuleWithRecordTypes(Type[] ruleRecordTypes)

Tests if this user can create a single Rule using the desired record types. While RulesManager.getRuleRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Rule . Providing an empty array tests if a Rule can be created with no records.

Parameters:

ruleRecordTypes - array of rule record types

Returns:

true if Rule creation using the specified record Types is supported, false otherwise

Throws:

NullArgumentException - ruleRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getRuleFormForCreate

RuleForm getRuleFormForCreate(Type[] ruleRecordTypes)
                       throws OperationFailedException,
PermissionDeniedException

Gets the rule form for creating new rules. A new form should be requested for each create transaction.

Parameters:

ruleRecordTypes - array of rule record types

Returns:

the rule form

Throws:

NullArgumentException - ruleRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form with requested record types

Compliance:

mandatory - This method must be implemented.

createRule

Rule createRule(RuleForm ruleForm)
         throws OperationFailedException,
PermissionDeniedException

Creates a new Rule .

Parameters:

ruleForm - the form for this Rule

Returns:

the new Rule

Throws:

IllegalStateException - ruleForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - ruleForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - ruleForm did not originate from getRuleFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateRules

boolean canUpdateRules()

Tests if this user can update Rules . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a Rule will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returns:

false if rule modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getRuleFormForUpdate

RuleForm getRuleFormForUpdate(Id ruleId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the rule form for updating an existing rule. A new rule form should be requested for each update transaction.

Parameters:

ruleId - the Id of the Rule

Returns:

the rule form

Throws:

NotFoundException - ruleId is not found

NullArgumentException - ruleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateRule

void updateRule(RuleForm ruleForm)
         throws OperationFailedException,
PermissionDeniedException

Updates an existing rule.

Parameters:

ruleForm - the form containing the elements to be updated

Throws:

IllegalStateException - ruleForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - ruleForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - ruleForm did not originate from getRuleFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteRules

boolean canDeleteRules()

Tests if this user can delete Rules . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a Rule will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returns:

false if Rule deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteRule

void deleteRule(Id ruleId)
         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Deletes the Rule identified by the given Id .

Parameters:

ruleId - the Id of the Rule to delete

Throws:

NotFoundException - a Rule was not found identified by the given Id

NullArgumentException - ruleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageRuleAliases

boolean canManageRuleAliases()

Tests if this user can manage Id aliases for Rules . A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returns:

false if Rule aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasRule

void aliasRule(Id ruleId,
 Id aliasId)
        throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an Id to a Rule for the purpose of creating compatibility. The primary Id of the Rule is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another rule, it is reassigned to the given rule Id .

Parameters:

ruleId - the Id of a Rule

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - ruleId not found

NullArgumentException - ruleId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.