org.kuali.rice.coreservice.api.style

Class Style

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

org.kuali.rice.coreservice.api.style.Style

All Implemented Interfaces:

Serializable, Inactivatable, GloballyUnique, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, StyleContract

public final class Style
extends AbstractDataTransferObject
implements StyleContract

An immutable representation of a Style. A style is essentially a block of XML containing and XSL stylesheet. These can be used in various places for the transformation of XML data from one form to another.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Style.Builder A builder which can be used to construct Style instances.
static class	Style.Cache

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() The unique identifier for an object.
String	getName() Returns the name of this style.
String	getObjectId() Return the globally unique object id of this object.
Long	getVersionNumber() Returns the version number for this object.
String	getXmlContent() Returns the XML definition of this style as a String.
boolean	isActive() The active indicator for an object.

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

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

Method Detail

getId

public String getId()

Description copied from interface: Identifiable

The unique identifier for an object. This can be null.

Specified by:

getId in interface Identifiable

Returns:

the id

getName

public String getName()

Description copied from interface: StyleContract

Returns the name of this style. All styles have a name and this value can never be null or blank. The name must be unique within the entire repository of existing styles.

Specified by:

getName in interface StyleContract

Returns:

the name of this style

getXmlContent

public String getXmlContent()

Description copied from interface: StyleContract

Returns the XML definition of this style as a String.

Specified by:

getXmlContent in interface StyleContract

Returns:

the xml definition of this style

isActive

public boolean isActive()

Description copied from interface: Inactivatable

The active indicator for an object.

Specified by:

isActive in interface Inactivatable

Returns:

true if active false if not.

getVersionNumber

public Long getVersionNumber()

Description copied from interface: Versioned

Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking.

Specified by:

getVersionNumber in interface Versioned

Returns:

the version number, or null if one has not been assigned yet

getObjectId

public String getObjectId()

Description copied from interface: GloballyUnique

Return the globally unique object id of this object. In general, this value should only be null if the object has not yet been stored to a persistent data store.

Specified by:

getObjectId in interface GloballyUnique

Returns:

the objectId of this object, or null if it has not been set yet