com.tridion.data

Interface CharacterData

All Superinterfaces:

Serializable

public interface CharacterData
extends Serializable

Interface for character data.

Method Summary

Modifier and Type	Method and Description
String	getCharsetName() Gets the charset name of this character data.
int	getComponentId() Gets the component id of this character data.
String	getContentType() Gets the content type of this character data.
int	getId() Gets the id of this character data.
InputStream	getInputStream() Gets an InputStream representing the character data.
InputStream	getInputStream(String encoding) Gets an InputStream representing the character data using specified encoding.
int	getNamespaceId() Gets the namespace id of this character data.
int	getPublicationId() Gets the publication id of this character data.
Integer	getRegionSchemaId() Gets region schema id.
Integer	getSchemaId() Gets schema id.
String	getString() Gets the character data as a String.
String	getString(String encoding) Gets the character data as a String, using a specified encoding.
int	getTemplateId() Gets the template id of this character data.
String	getTitle() Gets title.
String	getUrl() gets page url.

Method Detail

getNamespaceId

int getNamespaceId()

Gets the namespace id of this character data.

Returns:

the namespace id

getId

int getId()

Gets the id of this character data.

Returns:

The character data id.

getPublicationId

int getPublicationId()

Gets the publication id of this character data.

Returns:

The publication id.

getComponentId

int getComponentId()

Gets the component id of this character data.

Returns:

The component id.

getTemplateId

int getTemplateId()

Gets the template id of this character data.

Returns:

The template id.

getInputStream

InputStream getInputStream()
                    throws IOException

Gets an InputStream representing the character data.

Returns:

The character data as an InputStream.

Throws:

IOException - If an error occurs accessing the character data.

getInputStream

InputStream getInputStream(String encoding)
                    throws IOException

Gets an InputStream representing the character data using specified encoding.

Parameters:

encoding - The encoding to use to build the InputStream

Returns:

The character data as an InputStream.

Throws:

IOException - If an error occurs accessing the character data.

getString

String getString()
          throws IOException

Gets the character data as a String. By default, UTF-8 encoding is used.

Returns:

String representation of the character data.

Throws:

IOException - If an error occurs accessing the character data.

getString

String getString(String encoding)
          throws IOException

Gets the character data as a String, using a specified encoding.

Parameters:

encoding - The encoding to use to build the String result.

Returns:

String representation of the character data.

Throws:

IOException - If an error occurs accessing the character data.

getCharsetName

String getCharsetName()

Gets the charset name of this character data.

Returns:

The charset name.

getContentType

String getContentType()

Gets the content type of this character data.

Returns:

The content type.

getSchemaId

Integer getSchemaId()

Gets schema id.

Returns:

The schema id.

getRegionSchemaId

Integer getRegionSchemaId()

Gets region schema id.

Returns:

The schema id.

getUrl

String getUrl()

gets page url.

Returns:

url for page.

getTitle

String getTitle()

Gets title.

Returns:

title.