OSID — Rules Check Entities

Agenda

Osid Rule

An Agenda. An Agenda is a set of Instructions for some list of checks in a business process. The condition input record types may be used to constrain valid Checks or may reflect the Checks mapped to it via Instructions.

Like all OsidObjects, Agenda is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Operable
`isActive`	boolean		`true` if this operable is active, `false` if it is inactive
`isEnabled`	boolean		`true` if this operable is enabled, `false` if the active status is determined by other rules
`isDisabled`	boolean		`true` if this operable is disabled, `false` if the active status is determined by other rules
`isOperational`	boolean		`true` if this operable is operational, `false` otherwise
OsidRule
`hasRule`	boolean		`true` if an explicit rule is available, `false` otherwise
`ruleId`	id		the rule `Id`
`rule`	Rule		the rule
`conditionRecordTypes`	type	⋆	a list of `OsidCondition` record `Types`

Instruction

Osid Relationship

A Instruction appliies a Check to an Agenda.

Like all OsidObjects, Instruction is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Temporal
`isEffective`	boolean		`true` if this is effective, `false` otherwise
`startDate`	datetime		the start date
`endDate`	datetime		the end date
Operable
`isActive`	boolean		`true` if this operable is active, `false` if it is inactive
`isEnabled`	boolean		`true` if this operable is enabled, `false` if the active status is determined by other rules
`isDisabled`	boolean		`true` if this operable is disabled, `false` if the active status is determined by other rules
`isOperational`	boolean		`true` if this operable is operational, `false` otherwise
OsidRule
`hasRule`	boolean		`true` if an explicit rule is available, `false` otherwise
`ruleId`	id		the rule `Id`
`rule`	Rule		the rule
`conditionRecordTypes`	type	⋆	a list of `OsidCondition` record `Types`
OsidEnabler
`isRequirement`	boolean		`true` if this enabler is a requirement, `false` otherwise
`isOperationalOnSchedule`	boolean		`true` if the enabler is operational on a schedule, `false` otherwise
`scheduleId`	id		the schedule `Id`
`schedule`	Schedule		the schedule
`isOperationalDuringEvent`	boolean		`true` if the enabler is operational for an event, `false` otherwise
`eventId`	id		the event `Id`
`event`	Event		the event
`isOperationalDuringCyclicEvent`	boolean		`true` if the enabler is governed by a cyclic event, `false` otherwise
`cyclicEventId`	id		the cyclic event `Id`
`cyclicEvent`	CyclicEvent		the cyclic event
`isOperationalDuringTimePeriod`	boolean		`true` if the enabler applied to a time period, `false` otherwise
`timePeriodId`	id		the time period `Id`
`timePeriod`	TimePeriod		the time period
`isOperationalDuringCyclicTimePeriod`	boolean		`true` if the enabler is appleid to a cycic time period, `false` otherwise
`cyclicTimePeriodId`	id		the cyclic time period `Id`
`cyclicTimePeriod`	CyclicTimePeriod		the cyclic time period
OsidRelationship
`hasEndReason`	boolean		`true` if an end reason is available, `false` otherwise
`endReasonId`	id		a state `Id`
`endReason`	State		a state
OsidRuleApplicator
`isAppliedToTimePeriod`	boolean		`true` if the enabler applied to a time period, `false` otherwise
`appliedTimePeriodId`	id		the time period `Id`
`appliedTimePeriod`	TimePeriod		the time period
`isAppliedToCyclicTimePeriod`	boolean		`true` if the enabler is appleid to a cycic time period, `false` otherwise
`appliedCyclicTimePeriodId`	id		the cyclic time period `Id`
`appliedCyclicTimePeriod`	CyclicTimePeriod		the cyclic time period
`isAppliedToResource`	boolean		`true` if the rule applies to a resource, `false` otherwise
`appliedResourceId`	id		the resource `Id`
`appliedResource`	Resource		the resource

Name	Syntax	Description
`agendaId`	id	the agenda `Id`
`agenda`	Agenda	the agenda
`checkId`	id	the check `Id`
`check`	Check	the check
`message`	displaytext	the message
`isWarning`	boolean	`true` if this is a warning, `false` if an error
`continueOnFail`	boolean	`true` if this processing should continue on failure, `false` if processing should cease upon failure
`breakOnSuccess`	boolean	`true` if this processing should break on success, `false` if processing should continue
`order`	integer	the processing order

Check

Osid Rule

A Check is something that needs to checked. Some basic checks are baked into this interface but can be extended through a check record or it can reference an external rule evaluation. Each type of check is unique and should not be combined.

Checks come in a variety of flavors indicated by the boolean methods in this interface. Each type of Check may be accompanied by data required to evaluate the check.

Fail Check
Time Check By Date
Time Check by Event
Time Check By Cyclic Event
Hold Check
Authorization Check
Inquiry Check
Process Check
LoggingCheck

Like all OsidObjects, Check is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Operable
`isActive`	boolean		`true` if this operable is active, `false` if it is inactive
`isEnabled`	boolean		`true` if this operable is enabled, `false` if the active status is determined by other rules
`isDisabled`	boolean		`true` if this operable is disabled, `false` if the active status is determined by other rules
`isOperational`	boolean		`true` if this operable is operational, `false` otherwise
OsidRule
`hasRule`	boolean		`true` if an explicit rule is available, `false` otherwise
`ruleId`	id		the rule `Id`
`rule`	Rule		the rule
`conditionRecordTypes`	type	⋆	a list of `OsidCondition` record `Types`

Name	Syntax	Description
`isFailCheck`	boolean	`true` if this is a fail check, `false` otherwise
`isTimeCheckByDate`	boolean	`true` if this check is for a time specified by date, `false` otherwise
`timeCheckStartDate`	datetime	the start of the time period
`timeCheckEndDate`	datetime	the end of the time period
`isTimeCheckByEvent`	boolean	`true` if this check is for a time speciifed by event, `false` otherwise
`timeCheckEventId`	id	the event `Id`
`timeCheckEvent`	Event	the event
`isTimeCheckByCyclicEvent`	boolean	`true` if this check is for a time check specified by cyclic event, `false` otherwise
`timeCheckCyclicEventId`	id	the cyclic event `Id`
`timeCheckCyclicEvent`	CyclicEvent	the cyclic event
`isHoldCheck`	boolean	`true` if this check is for a block, `false` otherwise
`holdCheckBlockId`	id	the `Block Id`
`holdCheckBlock`	Block	the `Block`
`isAuthorizationCheck`	boolean	`true` if this check is for an authorization, `false` otherwise
`authorizationCheckFunctionId`	id	the `Function Id`
`authorizationCheckFunction`	Function	the `Function`
`isInquiryCheck`	boolean	`true` if this check is for a block, `false` otherwise
`inquiryCheckAuditId`	id	the `Block Id`
`inquiryCheckAudit`	Audit	the `Audit`
`isProcessCheck`	boolean	`true` if this check is for another agenda, `false` otherwise
`processCheckAgendaId`	id	the `Block Id`
`processCheckAgenda`	Agenda	the `Agenda`
`isLoggingCheck`	boolean	`true` if this check is for logging, `false` otherwise
`loggingCheckTextId`	id	the `Text Id`
`loggingCheckText`	Text	the `Text`

Rules Check

Checks

Agendas

Instructions

Evaluations

Engine Cataloging

Agenda

Instruction

Check