org.hippoecm.hst.rest.beans
Class ChannelDocument

java.lang.Object
  org.hippoecm.hst.rest.beans.ChannelDocument

All Implemented Interfaces:

Serializable

public class ChannelDocument
extends Object
implements Serializable

Information about a document in a certain channel.

See Also:

Serialized Form

Constructor Summary

ChannelDocument()
Creates an empty channel document bean.

ChannelDocument(ChannelDocument original)
Creates a copy of a channel document.

Method Summary

boolean	equals(Object o)
static boolean	equals(String str1, String str2)
String	getChannelId()
String	getChannelName()
String	getCmsPreviewPrefix()
String	getContextPath()
String	getHostName()
String	getMountPath()
String	getPathInfo()
String	getTemplateComposerContextPath()
int	hashCode()
void	setChannelId(String channelId) Sets the ID of the channel of this document.
void	setChannelName(String channelName) Sets the name of the channel of this document.
void	setCmsPreviewPrefix(String cmsPreviewPrefix)
void	setContextPath(String contextPath) Sets the contextpath of the URL
void	setHostName(String hostName)
void	setMountPath(String mountPath)
void	setPathInfo(String pathInfo)
void	setTemplateComposerContextPath(String templateComposerContextPath)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelDocument

public ChannelDocument()

Creates an empty channel document bean. This constructor is needed by the JAX-RS client framework.

ChannelDocument

public ChannelDocument(ChannelDocument original)

Creates a copy of a channel document.

Parameters:

original - the channel document to copy.

Method Detail

getChannelId

public String getChannelId()

Returns:

the ID of the channel of this document

setChannelId

public void setChannelId(String channelId)

Sets the ID of the channel of this document.

Parameters:

channelId - the ID of the channel of this document

getChannelName

public String getChannelName()

Returns:

the name of the channel of this document.

setChannelName

public void setChannelName(String channelName)

Sets the name of the channel of this document.

Parameters:

channelName - the name of the channel of this document

getContextPath

public String getContextPath()

Returns:

Returns the contextpath of the URL

setContextPath

public void setContextPath(String contextPath)

Sets the contextpath of the URL

Parameters:

contextPath -

getTemplateComposerContextPath

public String getTemplateComposerContextPath()

setTemplateComposerContextPath

public void setTemplateComposerContextPath(String templateComposerContextPath)

getCmsPreviewPrefix

public String getCmsPreviewPrefix()

Returns:

the cmsPreviewPrefix to access the channels in the cms. The value can be EMPTY ("") but never null

setCmsPreviewPrefix

public void setCmsPreviewPrefix(String cmsPreviewPrefix)

getPathInfo

public String getPathInfo()

Returns:

returns the pathInfo always starting with a slash or empty string

setPathInfo

public void setPathInfo(String pathInfo)

getMountPath

public String getMountPath()

setMountPath

public void setMountPath(String mountPath)

getHostName

public String getHostName()

setHostName

public void setHostName(String hostName)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public static boolean equals(String str1,
                             String str2)

toString

public String toString()

Overrides:

toString in class Object