org.opencms.ade.detailpage
Class CmsDetailPageConfigurationWriter

java.lang.Object
  extended by org.opencms.ade.detailpage.CmsDetailPageConfigurationWriter

public class CmsDetailPageConfigurationWriter
extends Object

Class for writing detail page information to an XML configuration file.

Since:
8.0.0

Field Summary
static String N_DETAIL_PAGE
          The detail page node.
static String N_PAGE
          The name of the node containing the reference to the actual detail page.
static String N_TYPE
          The name of the node which contains the type which the detail page renders.
 
Constructor Summary
CmsDetailPageConfigurationWriter(CmsObject cms, CmsResource res)
          Creates a new detail page configuration writer.
 
Method Summary
 void updateAndSave(List<CmsDetailPageInfo> infos, CmsUUID newId)
          Writes the new detail page information to the configuration file.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

N_DETAIL_PAGE

public static final String N_DETAIL_PAGE
The detail page node.

See Also:
Constant Field Values

N_PAGE

public static final String N_PAGE
The name of the node containing the reference to the actual detail page.

See Also:
Constant Field Values

N_TYPE

public static final String N_TYPE
The name of the node which contains the type which the detail page renders.

See Also:
Constant Field Values
Constructor Detail

CmsDetailPageConfigurationWriter

public CmsDetailPageConfigurationWriter(CmsObject cms,
                                        CmsResource res)
Creates a new detail page configuration writer.

Parameters:
cms - the current CMS context
res - the configuration file resource
Method Detail

updateAndSave

public void updateAndSave(List<CmsDetailPageInfo> infos,
                          CmsUUID newId)
                   throws CmsException
Writes the new detail page information to the configuration file.

Parameters:
infos - the new detail page information
newId - the id to use for new pages
Throws:
CmsException - if something goes wrong