PayloadInfo (The Adobe AEM Quickstart and Web Application.)

```
@ProviderType
public interface PayloadInfo
```
PayloadInfo is used to store all the available information about an InboxItem's payload. The most needed information is represented as first class properties. Any other information needed can be added to the custom properties Map.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class PayloadInfo.PAYLOAD_TYPE
Known Payload types

Nested Classes
Modifier and Type	Interface and Description
`static class`	`PayloadInfo.PAYLOAD_TYPE` Known Payload types

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`PayloadInfo`	`addCustomProperty(java.lang.String key, java.lang.Object value)` Add a property to the custom property `getCustomProperties()`
`java.lang.String`	`getAssetFolderPath()` Return the path to the asset folder associated with the payload.
`java.lang.String`	`getBrowserPath()` Return the path to be opened in a browser to load the representation of the payload.
`java.util.Calendar`	`getCreated()` Return the date and time when the payload was created.
`java.lang.String`	`getCreatedBy()` Returns the ID of the user who created the payload
`java.util.Map<java.lang.String,java.lang.Object>`	`getCustomProperties()` Return the custom property Map.
`java.lang.Object`	`getCustomProperty(java.lang.String key)` Return a custom property from the custom property `getCustomProperties()`.
`java.lang.String`	`getDescription()` Return the description of the payload.
`java.util.Calendar`	`getLastModified()` Return the date and time when the payload was last modified
`java.lang.String`	`getLastModifiedBy()` Returns the ID of the user who last modified the payload.
`java.lang.String`	`getLockedBy()` Returns the ID of the user who locked the payload.
`long`	`getMonthlyHits()` Return the number of monthly hits the payload has received.
`java.util.Calendar`	`getOffTime()` Return the date and time that the payload will be turned off.
`java.util.Calendar`	`getOnTime()` Return the date and time that the payload will be turned on.
`java.lang.String`	`getPath()` Return the path of the payload content.
`java.lang.String`	`getPayloadType()` Return the type of the payload
`java.lang.String`	`getThumbnailPath()` Return the path to the thumbnail that represents the payload
`long`	`getTimeUntilValid()` Return the amount of time in ms until the payload is considered valid.
`java.lang.String`	`getTitle()` Return the title associated with the payload.
`boolean`	`isActive()` Return whether or not the payload is active.
`boolean`	`isLocked()` Return whether or not the payload is locked.
`PayloadInfo`	`setAssetFolderPath(java.lang.String assetFolderPath)` Set the path to the asset folder associated with the payload.
`PayloadInfo`	`setBrowserPath(java.lang.String browserPath)` Set the path to be opened in a browser to load the representation of the payload.
`PayloadInfo`	`setCreated(java.util.Calendar created)` Set the date and time when the payload was created.
`PayloadInfo`	`setCreatedBy(java.lang.String createdBy)` Set the ID of the user who created the payload.
`PayloadInfo`	`setCustomProperties(java.util.Map<java.lang.String,java.lang.Object> customProperties)` Set the custom property Map.
`PayloadInfo`	`setDescription(java.lang.String description)` Set the description of the payload.
`PayloadInfo`	`setIsActive(boolean isActive)` Set whether or not the payload is active.
`PayloadInfo`	`setIsLocked(boolean isLocked)` Set whether or not the payload is locked.
`PayloadInfo`	`setLastModified(java.util.Calendar lastModified)` Set the date and time when the payload was last modified
`PayloadInfo`	`setLastModifiedBy(java.lang.String lastModifiedBy)` Set the ID of the user who last modified the payload.
`PayloadInfo`	`setLockedBy(java.lang.String lockedBy)` Set the ID of the user who locked the payload.
`PayloadInfo`	`setMonthlyHits(long monthlyHits)` Set the number of monthly hits the payload has received.
`PayloadInfo`	`setOffTime(java.util.Calendar offTime)` Set the date and time that the payload will be turned off.
`PayloadInfo`	`setOnTime(java.util.Calendar onTime)` Set the date and time that the payload will be turned on.
`PayloadInfo`	`setPath(java.lang.String path)` Set the path of the payload content.
`PayloadInfo`	`setPayloadType(java.lang.String payloadType)` Set the type of the payload
`PayloadInfo`	`setThumbnailPath(java.lang.String thumbnailPath)` Set the path to the thumbnail that represents the payload
`PayloadInfo`	`setTimeUntilValid(long timeUntilValid)` Set the amount of time in ms until the payload is considered valid.
`PayloadInfo`	`setTitle(java.lang.String title)` Set the title associated with the payload.

- Method Detail
  - getPath
```
java.lang.String getPath()
```
    Return the path of the payload content.
    
    Returns:
    
    the path to the payload content
    
    See Also:
    
    InboxItem.getContentPath()
  - setPath
```
PayloadInfo setPath(java.lang.String path)
```
    Set the path of the payload content.
    
    Parameters:
    
    path - the path to the payload content
    
    Returns:
    
    this PayloadInfo object
    
    See Also:
    
    InboxItem.getContentPath()
  - getBrowserPath
```
java.lang.String getBrowserPath()
```
    Return the path to be opened in a browser to load the representation of the payload.
    
    Returns:
    
    the path to the payload to be opened in a browser
  - setBrowserPath
```
PayloadInfo setBrowserPath(java.lang.String browserPath)
```
    Set the path to be opened in a browser to load the representation of the payload.
    
    Parameters:
    
    browserPath - the path to the payload to be opened in a browser
    
    Returns:
    
    this PayloadInfo object
  - getTitle
```
java.lang.String getTitle()
```
    Return the title associated with the payload.
    
    Returns:
    
    the payload's title
  - setTitle
```
PayloadInfo setTitle(java.lang.String title)
```
    Set the title associated with the payload.
    
    Parameters:
    
    title - the payload's title
    
    Returns:
    
    this PayloadInfo object
  - getThumbnailPath
```
java.lang.String getThumbnailPath()
```
    Return the path to the thumbnail that represents the payload
    
    Returns:
    
    the payload's thumbnail path
  - setThumbnailPath
```
PayloadInfo setThumbnailPath(java.lang.String thumbnailPath)
```
    Set the path to the thumbnail that represents the payload
    
    Parameters:
    
    thumbnailPath - the payload's thumbnail path
    
    Returns:
    
    this PayloadInfo object
  - getPayloadType
```
java.lang.String getPayloadType()
```
    Return the type of the payload
    
    Returns:
    
    the payload's type
    
    See Also:
    
    PayloadInfo.PAYLOAD_TYPE
  - setPayloadType
```
PayloadInfo setPayloadType(java.lang.String payloadType)
```
    Set the type of the payload
    
    Parameters:
    
    payloadType - the payload's type
    
    Returns:
    
    this PayloadInfo objet
    
    See Also:
    
    PayloadInfo.PAYLOAD_TYPE
  - getCreated
```
java.util.Calendar getCreated()
```
    Return the date and time when the payload was created.
    
    Returns:
    
    the Calendar representing when the payload was created
  - setCreated
```
PayloadInfo setCreated(java.util.Calendar created)
```
    Set the date and time when the payload was created.
    
    Parameters:
    
    created - the Calendar representing when the payload was created
    
    Returns:
    
    this PayloadInfo object
  - getCreatedBy
```
java.lang.String getCreatedBy()
```
    Returns the ID of the user who created the payload
    
    Returns:
    
    the ID of the user who create the payload
  - setCreatedBy
```
PayloadInfo setCreatedBy(java.lang.String createdBy)
```
    Set the ID of the user who created the payload.
    
    Parameters:
    
    createdBy - the ID of the user who created the payload
    
    Returns:
    
    this PayloadInfo object
  - getLastModified
```
java.util.Calendar getLastModified()
```
    Return the date and time when the payload was last modified
    
    Returns:
    
    the Calendar representing when the payload was last modified
  - setLastModified
```
PayloadInfo setLastModified(java.util.Calendar lastModified)
```
    Set the date and time when the payload was last modified
    
    Parameters:
    
    lastModified - the Calendar representing when the payload was last modified
    
    Returns:
    
    this PayloadInfo object
  - getLastModifiedBy
```
java.lang.String getLastModifiedBy()
```
    Returns the ID of the user who last modified the payload.
    
    Returns:
    
    the ID of the user who last modified the payload.
  - setLastModifiedBy
```
PayloadInfo setLastModifiedBy(java.lang.String lastModifiedBy)
```
    Set the ID of the user who last modified the payload.
    
    Parameters:
    
    lastModifiedBy - the ID of the user who last modified the payload
    
    Returns:
    
    this PayloadInfo objet
  - isLocked
```
boolean isLocked()
```
    Return whether or not the payload is locked.
    
    Returns:
    
    whether or not the payload is locked
  - setIsLocked
```
PayloadInfo setIsLocked(boolean isLocked)
```
    Set whether or not the payload is locked.
    
    Parameters:
    
    isLocked - whether or not the payload is locked
    
    Returns:
    
    this PayloadInfo object
  - getLockedBy
```
java.lang.String getLockedBy()
```
    Returns the ID of the user who locked the payload.
    
    Returns:
    
    the ID of the user who locked the payload
  - setLockedBy
```
PayloadInfo setLockedBy(java.lang.String lockedBy)
```
    Set the ID of the user who locked the payload.
    
    Parameters:
    
    lockedBy - the ID of the user who locked the payload
    
    Returns:
    
    this PayloadInfo object
  - getOnTime
```
java.util.Calendar getOnTime()
```
    Return the date and time that the payload will be turned on. Generally only used by payloads of type PayloadInfo.PAYLOAD_TYPE.PAGE.
    
    Returns:
    
    the Calendar representing the date and time that the payload will be turned on
  - setOnTime
```
PayloadInfo setOnTime(java.util.Calendar onTime)
```
    Set the date and time that the payload will be turned on. Generally only used by payloads of type PayloadInfo.PAYLOAD_TYPE.PAGE.
    
    Parameters:
    
    onTime - the Calendar representing the date and time that the payload will be turned on
    
    Returns:
    
    this PayloadInfo object
  - getOffTime
```
java.util.Calendar getOffTime()
```
    Return the date and time that the payload will be turned off. Generally only used by payloads of type PayloadInfo.PAYLOAD_TYPE.PAGE.
    
    Returns:
    
    the Calendar representing the date and time that the payload will be turned off
  - setOffTime
```
PayloadInfo setOffTime(java.util.Calendar offTime)
```
    Set the date and time that the payload will be turned off. Generally only used by payloads of type PayloadInfo.PAYLOAD_TYPE.PAGE.
    
    Parameters:
    
    offTime - the Calendar representing the date and time that the payload will be turned off
    
    Returns:
    
    this PayloadInfo object
  - getTimeUntilValid
```
long getTimeUntilValid()
```
    Return the amount of time in ms until the payload is considered valid. Generally only used by payloads of type PayloadInfo.PAYLOAD_TYPE.PAGE.
    
    Returns:
    
    the amount of time in ms until the payload is considered valid
  - setTimeUntilValid
```
PayloadInfo setTimeUntilValid(long timeUntilValid)
```
    Set the amount of time in ms until the payload is considered valid. Generally only used by payloads of type PayloadInfo.PAYLOAD_TYPE.PAGE
    
    Parameters:
    
    timeUntilValid - the amount of time in ms until the payload is considered valid
    
    Returns:
    
    this PayloadInfo object
  - getMonthlyHits
```
long getMonthlyHits()
```
    Return the number of monthly hits the payload has received. Generally only used by payloads of type PayloadInfo.PAYLOAD_TYPE.PAGE.
    
    Returns:
    
    the number of monthly hits the payload has received
  - setMonthlyHits
```
PayloadInfo setMonthlyHits(long monthlyHits)
```
    Set the number of monthly hits the payload has received. Generally only used by payloads of type PayloadInfo.PAYLOAD_TYPE.PAGE.
    
    Parameters:
    
    monthlyHits - the number of monthly hits the payload has received
    
    Returns:
    
    this PayloadInfo object
  - getDescription
```
java.lang.String getDescription()
```
    Return the description of the payload.
    
    Returns:
    
    the description of the payload
  - setDescription
```
PayloadInfo setDescription(java.lang.String description)
```
    Set the description of the payload.
    
    Parameters:
    
    description - the description of the payload
    
    Returns:
    
    this PayloadInfo object
  - getAssetFolderPath
```
java.lang.String getAssetFolderPath()
```
    Return the path to the asset folder associated with the payload. Generally only used by payloads of type PayloadInfo.PAYLOAD_TYPE.PROJECT.
    
    Returns:
    
    the path to the asset folder associated with the payload
  - setAssetFolderPath
```
PayloadInfo setAssetFolderPath(java.lang.String assetFolderPath)
```
    Set the path to the asset folder associated with the payload. Generally only used by payloads of type PayloadInfo.PAYLOAD_TYPE.PAGE.
    
    Parameters:
    
    assetFolderPath - the path to the asset folder associated with the payload
    
    Returns:
    
    this PayloadInfo object
  - isActive
```
boolean isActive()
```
    Return whether or not the payload is active. Generally only used by payloads of type PayloadInfo.PAYLOAD_TYPE.PAGE.
    
    Returns:
    
    whether or not the payload is active
  - setIsActive
```
PayloadInfo setIsActive(boolean isActive)
```
    Set whether or not the payload is active. Generally only used by payloads of type PayloadInfo.PAYLOAD_TYPE.PAGE.
    
    Parameters:
    
    isActive - whether or not the paylaod is active
    
    Returns:
    
    this PayloadInfo object
  - getCustomProperties
```
java.util.Map<java.lang.String,java.lang.Object> getCustomProperties()
```
    Return the custom property Map. Custom properties are used to store information about a payload beyond the most common properties.
    
    Returns:
    
    the custom property
  - setCustomProperties
```
PayloadInfo setCustomProperties(java.util.Map<java.lang.String,java.lang.Object> customProperties)
```
    Set the custom property Map. Custom properties are used to store information about a payload beyond the most common properties.
    
    Parameters:
    
    customProperties - the custom property getCustomProperties()
    
    Returns:
    
    this PayloadInfo object
  - addCustomProperty
```
PayloadInfo addCustomProperty(java.lang.String key,
                              java.lang.Object value)
```
    Add a property to the custom property getCustomProperties()
    
    Parameters:
    
    key - the property's key
    
    value - the property's value
    
    Returns:
    
    this PayloadInfo object
  - getCustomProperty
```
java.lang.Object getCustomProperty(java.lang.String key)
```
    Return a custom property from the custom property getCustomProperties().
    
    Parameters:
    
    key - the key to look up in the custom property Map
    
    Returns:
    
    the value for the property or null if the key isn't found in the Map

Interface PayloadInfo

Nested Class Summary

Method Summary

Method Detail

getPath

setPath

getBrowserPath

setBrowserPath

getTitle

setTitle

getThumbnailPath

setThumbnailPath

getPayloadType

setPayloadType

getCreated

setCreated

getCreatedBy

setCreatedBy

getLastModified

setLastModified

getLastModifiedBy

setLastModifiedBy

isLocked

setIsLocked

getLockedBy

setLockedBy

getOnTime

setOnTime

getOffTime

setOffTime

getTimeUntilValid

setTimeUntilValid

getMonthlyHits

setMonthlyHits

getDescription

setDescription

getAssetFolderPath

setAssetFolderPath

isActive

setIsActive

getCustomProperties

setCustomProperties

addCustomProperty

getCustomProperty