Page (Lutece 7.0.0-SNAPSHOT API)

java.lang.Object
- fr.paris.lutece.portal.business.page.Page

All Implemented Interfaces:

fr.paris.lutece.portal.service.rbac.RBACResource, IExtendableResource
```
public class Page
extends Object
implements fr.paris.lutece.portal.service.rbac.RBACResource, IExtendableResource
```
This class reprsents business objects Page

Field Summary

Fields
Modifier and Type Field and Description

static String IMAGE_RESOURCE_TYPE_ID

static String RESOURCE_TYPE

static String ROLE_NONE

Fields
Modifier and Type	Field and Description
`static String`	`IMAGE_RESOURCE_TYPE_ID`
`static String`	`RESOURCE_TYPE`
`static String`	`ROLE_NONE`

Constructor Summary

Constructors
Constructor and Description

Page()

Constructors
Constructor and Description
`Page()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getCodeTheme()` Returns the theme of the page
`Timestamp`	`getDateUpdate()` Returns the date to which the content page has been modified
`String`	`getDescription()` Returns the description of the page
`boolean`	`getDisplayDateUpdate()` Get the DisplayDateUpdate
`String`	`getExtendableResourceDescription()` Gets the name.
`String`	`getExtendableResourceImageUrl()` Gets the URL of the image describing the resource.
`String`	`getExtendableResourceName()` Gets the name.
`String`	`getExtendableResourceType()` Gets the resource type.
`int`	`getId()` Returns the identifier of the page
`Integer`	`getIdAuthorizationNode()` get the id of the authorization node
`String`	`getIdExtendableResource()` Gets the id.
`byte[]`	`getImageContent()` Returns the ImageContent
`boolean`	`getIsManualDateUpdate()` Get the boolean for manual date update
`String`	`getMetaDescription()`
`String`	`getMetaKeywords()`
`String`	`getMimeType()` Returns the MimeType
`String`	`getName()` Returns the name of the page
`int`	`getNodeStatus()` Returns the NodeStatus of the page
`int`	`getOrder()` Returns the position of the page into a portlet child pages
`int`	`getOrigParentPageId()` Returns the identifier of the parent page as loaded from the db
`int`	`getPageTemplateId()` Returns the identifier of the template for the page-setting
`int`	`getParentPageId()` Returns the identifier of the parent current page
`List<Portlet>`	`getPortlets()` Returns the portlets list contained into the page
`String`	`getResourceId()` Returns the resource Id of the current object
`String`	`getResourceTypeCode()` Returns the Resource Type Code that identify the resource type
`String`	`getRole()` Gets the page role
`int`	`getStatus()` Returns the status of the current page
`String`	`getTemplate()` Returns the name of the template file for page-setting
`boolean`	`isVisible(javax.servlet.http.HttpServletRequest request)` Checks if the page is visible for the current user
`void`	`setCodeTheme(String strCodeTheme)` Sets the Theme of the page to the specified string.
`void`	`setDateUpdate(Timestamp dateUpdate)` Sets the date to which the content page has been modified
`void`	`setDescription(String strDescription)` Sets the description of the page
`void`	`setDisplayDateUpdate(boolean bDisplayDateUpdate)` Set DisplayDateUpdate
`void`	`setId(int nId)` Sets the identifier of the page
`void`	`setIdAuthorizationNode(Integer nIdAutorizationNode)` set the id of the authorization node
`void`	`setImageContent(byte[] strImageContent)` Sets the ImageContent
`void`	`setIsManualDateUpdate(boolean bIsManualDateUpdate)` Set boolean for manual date update
`void`	`setMetaDescription(String strMetaDescription)` set the META description
`void`	`setMetaKeywords(String strMetaKeywords)` set the META name
`void`	`setMimeType(String strMimeType)` Sets the MimeType
`void`	`setName(String strName)` Sets the name of the page
`void`	`setNodeStatus(int nNodeStatus)` Sets the node_status of the page
`void`	`setOrder(int nOrder)` Sets the position of the current page into a portlet child pages
`void`	`setPageTemplateId(int nPageTemplateId)` Sets the identifier of the template for the page-setting
`void`	`setParentPageId(int nParentPageId)` Sets the identifier of the parent current page
`void`	`setPortlets(List<Portlet> listPortlets)` Sets the date to which the portlets list has been modified
`void`	`setRole(String strRole)` Sets the page's role
`void`	`setStatus(int nStatus)` Sets the status of the current page (active or not active)
`void`	`setTemplate(String strTemplate)` Sets the name of the template file for page-setting

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RESOURCE_TYPE
```
public static final String RESOURCE_TYPE
```
    See Also:
    
    Constant Field Values
  - IMAGE_RESOURCE_TYPE_ID
```
public static final String IMAGE_RESOURCE_TYPE_ID
```
    See Also:
    
    Constant Field Values
  - ROLE_NONE
```
public static final String ROLE_NONE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Page
```
public Page()
```
- Method Detail
  - setId
```
public void setId(int nId)
```
    Sets the identifier of the page
    
    Parameters:
    
    nId - the page identifier
  - getId
```
public int getId()
```
    Returns the identifier of the page
    
    Returns:
    
    page identifier
  - setParentPageId
```
public void setParentPageId(int nParentPageId)
```
    Sets the identifier of the parent current page
    
    Parameters:
    
    nParentPageId - the parent page identifier
  - getParentPageId
```
public int getParentPageId()
```
    Returns the identifier of the parent current page
    
    Returns:
    
    the parent page identifier
  - getOrigParentPageId
```
public int getOrigParentPageId()
```
    Returns the identifier of the parent page as loaded from the db
    
    Returns:
    
    the parent page identifier
    
    Since:
    
    5.1.0
  - getImageContent
```
public byte[] getImageContent()
```
    Returns the ImageContent
    
    Returns:
    
    The ImageContent
  - setImageContent
```
public void setImageContent(byte[] strImageContent)
```
    Sets the ImageContent
    
    Parameters:
    
    strImageContent - The ImageContent
  - getMimeType
```
public String getMimeType()
```
    Returns the MimeType
    
    Returns:
    
    The MimeType
  - setMimeType
```
public void setMimeType(String strMimeType)
```
    Sets the MimeType
    
    Parameters:
    
    strMimeType - The MimeType
  - setName
```
public void setName(String strName)
```
    Sets the name of the page
    
    Parameters:
    
    strName - The page name
  - getName
```
public String getName()
```
    Returns the name of the page
    
    Returns:
    
    the page name
  - setPageTemplateId
```
public void setPageTemplateId(int nPageTemplateId)
```
    Sets the identifier of the template for the page-setting
    
    Parameters:
    
    nPageTemplateId - the template identifier
  - getPageTemplateId
```
public int getPageTemplateId()
```
    Returns the identifier of the template for the page-setting
    
    Returns:
    
    the template identifier
  - setTemplate
```
public void setTemplate(String strTemplate)
```
    Sets the name of the template file for page-setting
    
    Parameters:
    
    strTemplate - the template filename
  - getTemplate
```
public String getTemplate()
```
    Returns the name of the template file for page-setting
    
    Returns:
    
    the template filename
  - setOrder
```
public void setOrder(int nOrder)
```
    Sets the position of the current page into a portlet child pages
    
    Parameters:
    
    nOrder - the current page position into a portlet child pages
  - getOrder
```
public int getOrder()
```
    Returns the position of the page into a portlet child pages
    
    Returns:
    
    the current page position
  - setStatus
```
public void setStatus(int nStatus)
```
    Sets the status of the current page (active or not active)
    
    Parameters:
    
    nStatus - the page status
  - getStatus
```
public int getStatus()
```
    Returns the status of the current page
    
    Returns:
    
    the current page status
  - setDescription
```
public void setDescription(String strDescription)
```
    Sets the description of the page
    
    Parameters:
    
    strDescription - the page description
  - getDescription
```
public String getDescription()
```
    Returns the description of the page
    
    Returns:
    
    the description page
  - setNodeStatus
```
public void setNodeStatus(int nNodeStatus)
```
    Sets the node_status of the page
    
    Parameters:
    
    nNodeStatus - the node status
  - getNodeStatus
```
public int getNodeStatus()
```
    Returns the NodeStatus of the page
    
    Returns:
    
    the NodeStatus page
  - getPortlets
```
public List<Portlet> getPortlets()
```
    Returns the portlets list contained into the page
    
    Returns:
    
    the portlets list
  - setPortlets
```
public void setPortlets(List<Portlet> listPortlets)
```
    Sets the date to which the portlets list has been modified
    
    Parameters:
    
    listPortlets - the portlet list
  - setDateUpdate
```
public void setDateUpdate(Timestamp dateUpdate)
```
    Sets the date to which the content page has been modified
    
    Parameters:
    
    dateUpdate - the date of modification
  - getDateUpdate
```
public Timestamp getDateUpdate()
```
    Returns the date to which the content page has been modified
    
    Returns:
    
    the date of modification
  - getRole
```
public String getRole()
```
    Gets the page role
    
    Returns:
    
    page's role as a String
    
    Since:
    
    v1.1
  - setRole
```
public void setRole(String strRole)
```
    Sets the page's role
    
    Parameters:
    
    strRole - The role
    
    Since:
    
    v1.1
  - getCodeTheme
```
public String getCodeTheme()
```
    Returns the theme of the page
    
    Returns:
    
    The theme of the page as a string.
  - setCodeTheme
```
public void setCodeTheme(String strCodeTheme)
```
    Sets the Theme of the page to the specified string.
    
    Parameters:
    
    strCodeTheme - The new Theme of the page.
  - isVisible
```
public boolean isVisible(javax.servlet.http.HttpServletRequest request)
```
    Checks if the page is visible for the current user
    
    Parameters:
    
    request - The HTTP request
    
    Returns:
    
    true if the page could be shown to the user
    
    Since:
    
    v1.3.1
  - getResourceTypeCode
```
public String getResourceTypeCode()
```
    Returns the Resource Type Code that identify the resource type
    
    Specified by:
    
    getResourceTypeCode in interface fr.paris.lutece.portal.service.rbac.RBACResource
    
    Returns:
    
    The Resource Type Code
  - getResourceId
```
public String getResourceId()
```
    Returns the resource Id of the current object
    
    Specified by:
    
    getResourceId in interface fr.paris.lutece.portal.service.rbac.RBACResource
    
    Returns:
    
    The resource Id of the current object
  - getMetaKeywords
```
public String getMetaKeywords()
```
    Returns:
    
    the META Name associate to the page
  - setMetaKeywords
```
public void setMetaKeywords(String strMetaKeywords)
```
    set the META name
    
    Parameters:
    
    strMetaKeywords - the META name
  - getMetaDescription
```
public String getMetaDescription()
```
    Returns:
    
    the META description associate to the page
  - setMetaDescription
```
public void setMetaDescription(String strMetaDescription)
```
    set the META description
    
    Parameters:
    
    strMetaDescription - the META description
  - setIdAuthorizationNode
```
public void setIdAuthorizationNode(Integer nIdAutorizationNode)
```
    set the id of the authorization node
    
    Parameters:
    
    nIdAutorizationNode - The authorization node ID
  - getIdAuthorizationNode
```
public Integer getIdAuthorizationNode()
```
    get the id of the authorization node
    
    Returns:
    
    the authorization node id
  - getIdExtendableResource
```
public String getIdExtendableResource()
```
    Gets the id.
    
    Specified by:
    
    getIdExtendableResource in interface IExtendableResource
    
    Returns:
    
    The id
  - getExtendableResourceType
```
public String getExtendableResourceType()
```
    Gets the resource type.
    
    Specified by:
    
    getExtendableResourceType in interface IExtendableResource
    
    Returns:
    
    The resource type
  - getExtendableResourceName
```
public String getExtendableResourceName()
```
    Gets the name.
    
    Specified by:
    
    getExtendableResourceName in interface IExtendableResource
    
    Returns:
    
    The name
  - getExtendableResourceDescription
```
public String getExtendableResourceDescription()
```
    Gets the name.
    
    Specified by:
    
    getExtendableResourceDescription in interface IExtendableResource
    
    Returns:
    
    The name
  - getExtendableResourceImageUrl
```
public String getExtendableResourceImageUrl()
```
    Gets the URL of the image describing the resource. If the given URL does NOT starts with http://, then the base URL will be prefixed.
    
    Specified by:
    
    getExtendableResourceImageUrl in interface IExtendableResource
    
    Returns:
    
    The URL of the image describing the resource, or null if not image is associated to this resource
  - getDisplayDateUpdate
```
public boolean getDisplayDateUpdate()
```
    Get the DisplayDateUpdate
    
    Returns:
    
    the DisplayDateUpdate boolean
  - setDisplayDateUpdate
```
public void setDisplayDateUpdate(boolean bDisplayDateUpdate)
```
    Set DisplayDateUpdate
    
    Parameters:
    
    bDisplayDateUpdate -
  - getIsManualDateUpdate
```
public boolean getIsManualDateUpdate()
```
    Get the boolean for manual date update
    
    Returns:
    
    the isManualDateUpdate boolean
  - setIsManualDateUpdate
```
public void setIsManualDateUpdate(boolean bIsManualDateUpdate)
```
    Set boolean for manual date update
    
    Parameters:
    
    bIsManualDateUpdate -

Class Page

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RESOURCE_TYPE

IMAGE_RESOURCE_TYPE_ID

ROLE_NONE

Constructor Detail

Page

Method Detail

setId

getId

setParentPageId

getParentPageId

getOrigParentPageId

getImageContent

setImageContent

getMimeType

setMimeType

setName

getName

setPageTemplateId

getPageTemplateId

setTemplate

getTemplate

setOrder

getOrder

setStatus

getStatus

setDescription

getDescription

setNodeStatus

getNodeStatus

getPortlets

setPortlets

setDateUpdate

getDateUpdate

getRole

setRole

getCodeTheme

setCodeTheme

isVisible

getResourceTypeCode

getResourceId

getMetaKeywords

setMetaKeywords

getMetaDescription

setMetaDescription

setIdAuthorizationNode

getIdAuthorizationNode

getIdExtendableResource

getExtendableResourceType

getExtendableResourceName

getExtendableResourceDescription

getExtendableResourceImageUrl

getDisplayDateUpdate

setDisplayDateUpdate

getIsManualDateUpdate

setIsManualDateUpdate