MarkupDefinition Class

com.bea.netuix.application.definition
MarkupDefinition Class

public class MarkupDefinition

    extends Object
    implements Serializable

This class represents a persistant markup for all WebLogic Portal Framework entities.


Hierarchy
Object
  MarkupDefinition
All Implemented Interfaces

Serializable

Field Summary

public static final MarkupDefinitionId
MARKUP_BOOK_ID
MarkupDefinitionId
public static final MarkupDefinitionId
MARKUP_BOOK_NO_MIN_NO_MAX_ID
MarkupDefinitionId
public static final MarkupDefinitionId
MARKUP_BOOK_VISITOR_TOOL_ID
MarkupDefinitionId
public static final MarkupDefinitionId
MARKUP_DESKTOP_ID
MarkupDefinitionId
public static final MarkupDefinitionId
MARKUP_JAVA_PORTLET_ID
MarkupDefinitionId
public static final MarkupDefinitionId
MARKUP_PAGE_ID
MarkupDefinitionId
public static final MarkupDefinitionId
MARKUP_SIMPLE_PORTLET_ID
MarkupDefinitionId
 

Constructor Summary

MarkupDefinition(String name, String type, String webAppName, String markupFile, String beginXml, String endXml)

Constructor to create a new MarkupDefinition object.
 

Method Summary

public boolean
equivalent(MarkupDefinition other)
Are these two markups equivalent in name, type, beginXML, endXML, webappName, markupfile
public String
getBeginXml()
Returns the begin xml fragment for this markup.
public String
getEndXml()
Returns the end xml fragment for this markup.
public MarkupDefinitionId
getMarkupDefinitionId()
Returns the MarkupDefinitionId for this markup.
public String
getMarkupFile()
Returns the path to the markup file for this markup.
public String
getName()
Returns the name of this markup
public String
getType()
Returns the type of this markup.
public String
getWebAppName()
Returns the web application this markup is scoped to
public void
setBeginXml(String beginXml)
Sets the begin xml fragment for this markup.
public void
setEndXml(String endXml)
Sets the end xml fragment for this markup.
public void
setMarkupFile(String markupFile)
Sets the markup file path for this markup.
public void
setName(String name)
Sets the name of this markup
public void
setType(String type)
Sets the type of this markup.
public void
setWebAppName(String webAppName)
Scopes this markup to given web application
public String
toString()
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
   

Field Detail

MARKUP_BOOK_ID

public static final MarkupDefinitionId MARKUP_BOOK_ID


MARKUP_BOOK_NO_MIN_NO_MAX_ID

public static final MarkupDefinitionId MARKUP_BOOK_NO_MIN_NO_MAX_ID


MARKUP_BOOK_VISITOR_TOOL_ID

public static final MarkupDefinitionId MARKUP_BOOK_VISITOR_TOOL_ID


MARKUP_DESKTOP_ID

public static final MarkupDefinitionId MARKUP_DESKTOP_ID


MARKUP_JAVA_PORTLET_ID

public static final MarkupDefinitionId MARKUP_JAVA_PORTLET_ID


MARKUP_PAGE_ID

public static final MarkupDefinitionId MARKUP_PAGE_ID


MARKUP_SIMPLE_PORTLET_ID

public static final MarkupDefinitionId MARKUP_SIMPLE_PORTLET_ID

 

Constructor Detail

MarkupDefinition

public MarkupDefinition(String name, 
                        String type, 
                        String webAppName, 
                        String markupFile, 
                        String beginXml, 
                        String endXml)
Constructor to create a new MarkupDefinition object.
 

Method Detail

equivalent(MarkupDefinition) Method

public boolean equivalent(MarkupDefinition other)
Are these two markups equivalent in name, type, beginXML, endXML, webappName, markupfile

Parameters

other
the other MarkupDefinition

Returns

true if they are equivalent

getBeginXml() Method

public String getBeginXml()
Returns the begin xml fragment for this markup.

Returns

begin xml fragment

getEndXml() Method

public String getEndXml()
Returns the end xml fragment for this markup.

Returns

end xml fragment

getMarkupDefinitionId() Method

public MarkupDefinitionId getMarkupDefinitionId()
Returns the MarkupDefinitionId for this markup. Returns NULL if this markup has not been retrieved using the persistence API.

Returns

MarkupDefinitionId

getMarkupFile() Method

public String getMarkupFile()
Returns the path to the markup file for this markup. This path is relative to the web application context.

Returns

markup file path

getName() Method

public String getName()
Returns the name of this markup

Returns

markup name

getType() Method

public String getType()
Returns the type of this markup.

Returns

markup type

getWebAppName() Method

public String getWebAppName()
Returns the web application this markup is scoped to

Returns

web application name

setBeginXml(String) Method

public void setBeginXml(String beginXml)
Sets the begin xml fragment for this markup.


setEndXml(String) Method

public void setEndXml(String endXml)
Sets the end xml fragment for this markup.


setMarkupFile(String) Method

public void setMarkupFile(String markupFile)
Sets the markup file path for this markup.


setName(String) Method

public void setName(String name)
Sets the name of this markup


setType(String) Method

public void setType(String type)
Sets the type of this markup.


setWebAppName(String) Method

public void setWebAppName(String webAppName)
Scopes this markup to given web application


toString() Method

public String toString()
Overrides
Object.toString()