Class AbstractSourceableOsidObject

java.lang.Object

net.okapia.osid.jamocha.spi.AbstractIdentifiable

net.okapia.osid.jamocha.spi.AbstractOsidObject

net.okapia.osid.jamocha.spi.AbstractSourceableOsidObject

All Implemented Interfaces:

Browsable, Extensible, Identifiable, OsidObject, Sourceable

Direct Known Subclasses:

AbstractAsset, AbstractComposition, AbstractEntry, AbstractInstallationPackage, AbstractOsidCatalog, AbstractOsidGovernator, AbstractRecipe

public abstract class AbstractSourceableOsidObject
extends AbstractOsidObject
implements Sourceable, OsidObject

Defines a sourceable OsidObject. setProvider() should be used to set the provider information by subclasses.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractSourceableOsidObject.Sourceable	Composed Sourceable.

Nested classes/interfaces inherited from class AbstractOsidObject

AbstractOsidObject.Browsable

Modifier and Type	Class	Description
protected class	AbstractOsidObject.Browsable	Composed Browsable.

Constructor Summary

Constructors

Constructor	Description
AbstractSourceableOsidObject()	Constructs a new AbstractSourceableOsidObject.

Method Summary

Modifier and Type	Method	Description
protected void	addAssetsToBranding(Collection<Asset> assets)	Adds assets to the branding.
protected void	addAssetToBranding(Asset asset)	Adds an asset to the branding.
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids, such as an image or logo, expressed using the Asset interface.
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider of this catalog.
Id	getProviderId()	Gets the Id of the Provider of this Catalog.
protected void	setBranding(Collection<Asset> assets)	Sets the branding to the given assets.
protected void	setBranding(Asset asset)	Sets the branding to the given asset.
protected void	setLicense(DisplayText license)	Sets the license.
protected void	setProvider(Provider provider)	Sets the provider for this catalog.
protected void	setProvider(Resource provider)	Sets the provider.

Methods inherited from class AbstractOsidObject

addProperties, addRecordType, getDescription, getDisplayName, getGenusType, getProperties, getPropertiesByRecordType, getRecordTypes, hasRecordType, isOfGenusType, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
protected void	addProperties(Collection<Property> set, Type recordType)	Adds a property set.
protected void	addRecordType(Type recordType)	Adds a record type.
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
PropertyList	getProperties()	Gets a list of all properties of this object including those corresponding to data within this object's records.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets the properties by record type.
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type.
protected void	setDescription(DisplayText description)	Sets the description of this object.
protected void	setDisplayName(DisplayText displayName)	Sets the displayName for this object.
protected void	setGenusType(Type genusType)	Sets a genus type.

Methods inherited from class AbstractIdentifiable

current, equals, getId, hashCode, isCurrent, setId, stale, toString

Modifier and Type	Method	Description
protected void	current()	Sets the current flag to true.
final boolean	equals(Object obj)	Determines if the given Id is equal to this one.
Id	getId()	Gets the Id associated with this instance of this OSID object.
int	hashCode()	Returns a hash code value for this OsidObject based on the Id.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.
protected void	setId(Id id)	Sets the Id associated with this instance of this OSID object.
protected void	stale()	Sets the current flag to false.
String	toString()	Returns a string representation of this OsidObject.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AbstractSourceableOsidObject

public AbstractSourceableOsidObject()

Constructs a new AbstractSourceableOsidObject.

Method Details

getProviderId

@OSID
public Id getProviderId()

Gets the Id of the Provider of this Catalog.

Specified by:

getProviderId in interface Sourceable

Returns:

the Provider Id

getProvider

@OSID
public Resource getProvider()
                     throws OperationFailedException

Gets the Resource representing the provider of this catalog.

Specified by:

getProvider in interface Sourceable

Returns:

the provider

Throws:

OperationFailedException - unable to complete request

setProvider

protected void setProvider(Provider provider)

Sets the provider for this catalog.

Parameters:

provider - the new provider

Throws:

NullArgumentException - provider is null

setProvider

protected void setProvider(Resource provider)

Sets the provider.

Parameters:

provider - the new provider

Throws:

NullArgumentException - provider is null

getBrandingIds

@OSID
public IdList getBrandingIds()

Gets the branding asset Ids, such as an image or logo, expressed using the Asset interface.

Specified by:

getBrandingIds in interface Sourceable

Returns:

a list of asset Ids

getBranding

@OSID
public AssetList getBranding()
                      throws OperationFailedException

Gets a branding, such as an image or logo, expressed using the Asset interface.

Specified by:

getBranding in interface Sourceable

Returns:

a list of assets

Throws:

OperationFailedException - unable to complete request

addAssetToBranding

protected void addAssetToBranding(Asset asset)

Adds an asset to the branding.

Parameters:

asset - an asset to add

Throws:

NullArgumentException - asset is null

addAssetsToBranding

protected void addAssetsToBranding(Collection<Asset> assets)

Adds assets to the branding.

Parameters:

assets - array of assets to add

Throws:

NullArgumentException - asset is null

setBranding

protected void setBranding(Asset asset)

Sets the branding to the given asset.

Parameters:

asset - an asset to set

Throws:

NullArgumentException - asset is null

setBranding

protected void setBranding(Collection<Asset> assets)

Sets the branding to the given assets.

Parameters:

assets - an array of assets to setd

Throws:

NullArgumentException - assets is null

getLicense

@OSID
public DisplayText getLicense()

Gets the terms of usage. An empty license means the terms are unknown.

Specified by:

getLicense in interface Sourceable

Returns:

the license

setLicense

protected void setLicense(DisplayText license)

Sets the license.

Parameters:

license - the license

Throws:

NullArgumentException - license is null