OSID — Subscription Entities

Subscription

Osid Relationship

A Subscription relates a subscriber to a Dispatch and also contains the subscriber's Address to use as the means of contact in this context.

Like all OsidObjects, Subscription 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
OsidRelationship
`hasEndReason`	boolean		`true` if an end reason is available, `false` otherwise
`endReasonId`	id		a state `Id`
`endReason`	State		a state

Name	Syntax	Description
`dispatchId`	id	the dispatch `Id`
`dispatch`	Dispatch	the dispatch `Id`
`subscriberId`	id	the subscriber `Id`
`subscriber`	Resource	the subscriber
`addressId`	id	the address `Id`
`address`	Address	the subscriber's address.

Dispatch

Osid Governator

A Dispatch represents a collection of subscriptions. Like all OSID objects, a Dispatch is identified by its Id and any persisted references should use the Id.

Like all OsidObjects, Dispatch 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

Name	Syntax	Many	Description
`editorIds`	id	⋆	the editor `Ids`
`editors`	Resource	⋆	the editors
`addressGenusTypes`	type	⋆	a list of address genus types

Publisher

Osid Catalog

A Publisher represents a collection of subscriptions. Like all OSID objects, a Publisher is identified by its Id and any persisted references should use the Id.

Like all OsidObjects, Publisher 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
Sourceable
`providerId`	id		the provider `Id`
`provider`	Resource		the provider
`brandingIds`	id	⋆	a list of asset `Ids`
`branding`	Asset	⋆	a list of assets
`license`	displaytext		the license

Subscription

Dispatches

Subscriptions

Publisher Cataloging

Sub Packages

Subscription

Dispatch

Publisher