Package com.blockchyp.client.dto

Class BrandingAsset

java.lang.Object
com.blockchyp.client.dto.BrandingAsset
All Implemented Interfaces:
IAbstractAcknowledgement, ITimeoutRequest
public class BrandingAsset extends Object implements ITimeoutRequest, IAbstractAcknowledgement
Models the priority and display settings for terminal media.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BrandingAsset()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addDaysOfWeek(Weekday value)
    Adds a an array of days of the week during which a branding asset should be enabled.
    String
    getAssetType()
    Gets the type of branding asset.
    Collection<Weekday>
    getDaysOfWeek()
    Gets an array of days of the week during which a branding asset should be enabled.
    String
    getEndDate()
    Gets the end date if this asset should be displayed based on a schedule.
    String
    getEndTime()
    Gets the end date if this asset should be displayed based on a schedule.
    String
    getError()
    Gets the error, if an error occurred.
    String
    getId()
    Gets id used to track a branding asset.
    String
    getLastModified()
    Gets the time and date this asset was last modified.
    String
    getMediaId()
    Gets the media id associated with this branding asset, if any.
    String
    getMerchantId()
    Gets the merchant id associated with this branding asset.
    String
    getNarrativeDisplayPeriod()
    Gets a compact narrative string explaining the display period for a branding asset.
    String
    getNarrativeEffectiveDates()
    Gets a compact narrative string explaining the effective date and time rules for a branding asset.
    String
    getNotes()
    Gets a field for notes related to a branding asset.
    int
    getOrdinal()
    Gets the ordinal number marking the position of this asset within the branding stack.
    String
    getOrganizationId()
    Gets the organization id associated with this branding asset.
    String
    getOwnerId()
    Gets the id owner of the tenant who owns the branding asset.
    String
    getOwnerName()
    Gets the name of the tenant or entity that owns the branding asset.
    String
    getOwnerType()
    Gets the type of user or tenant that owns this asset.
    String
    getOwnerTypeCaption()
    Gets a recommended caption for displaying the owner.
    String
    getPartnerId()
    Gets the partner id associated with this branding asset.
    String
    getPreviewImage()
    Gets the recommended image to be displayed when rendering a preview of this branding asset.
    String
    getResponseDescription()
    Gets a narrative description of the transaction result.
    String
    getSlideShowId()
    Gets the slide show associated with this branding asset, if any.
    String
    getStartDate()
    Gets the start date if this asset should be displayed based on a schedule.
    String
    getStartTime()
    Gets the start date if this asset should be displayed based on a schedule.
    String
    getTerminalGroupId()
    Gets the terminal group id if this branding asset is specific to a terminal group.
    String
    getTerminalId()
    Gets the terminal id if this branding asset is specific to a single terminal.
    String
    getThumbnail()
    Gets the fully qualified URL of the thumbnail image for this branding asset.
    int
    getTimeout()
    Gets the request timeout in seconds.
    String
    getUserId()
    Gets id of the user who created this branding asset, if applicable.
    String
    getUserName()
    Gets name of the user who created this branding asset, if applicable.
    boolean
    isEditable()
    Gets if true, the API credentials used to retrieve the branding asset record can be used to update it.
    boolean
    isEnabled()
    Gets enables the asset for display.
    boolean
    isPadded()
    Gets applies standard margins to images displayed on terminals.
    boolean
    isPreview()
    Gets if true, the asset will be displayed in the merchant portal, but not on merchant terminal hardware.
    boolean
    isSuccess()
    Gets whether or not the request succeeded.
    boolean
    isTest()
    Gets whether or not to route transaction to the test gateway.
    void
    setAssetType(String value)
    Sets the type of branding asset.
    void
    setDaysOfWeek(Collection<Weekday> value)
    Sets an array of days of the week during which a branding asset should be enabled.
    void
    setEditable(boolean value)
    Sets if true, the API credentials used to retrieve the branding asset record can be used to update it.
    void
    setEnabled(boolean value)
    Sets enables the asset for display.
    void
    setEndDate(String value)
    Sets the end date if this asset should be displayed based on a schedule.
    void
    setEndTime(String value)
    Sets the end date if this asset should be displayed based on a schedule.
    void
    setError(String value)
    Sets the error, if an error occurred.
    void
    setId(String value)
    Sets id used to track a branding asset.
    void
    setLastModified(String value)
    Sets the time and date this asset was last modified.
    void
    setMediaId(String value)
    Sets the media id associated with this branding asset, if any.
    void
    setMerchantId(String value)
    Sets the merchant id associated with this branding asset.
    void
    setNarrativeDisplayPeriod(String value)
    Sets a compact narrative string explaining the display period for a branding asset.
    void
    setNarrativeEffectiveDates(String value)
    Sets a compact narrative string explaining the effective date and time rules for a branding asset.
    void
    setNotes(String value)
    Sets a field for notes related to a branding asset.
    void
    setOrdinal(int value)
    Sets the ordinal number marking the position of this asset within the branding stack.
    void
    setOrganizationId(String value)
    Sets the organization id associated with this branding asset.
    void
    setOwnerId(String value)
    Sets the id owner of the tenant who owns the branding asset.
    void
    setOwnerName(String value)
    Sets the name of the tenant or entity that owns the branding asset.
    void
    setOwnerType(String value)
    Sets the type of user or tenant that owns this asset.
    void
    setOwnerTypeCaption(String value)
    Sets a recommended caption for displaying the owner.
    void
    setPadded(boolean value)
    Sets applies standard margins to images displayed on terminals.
    void
    setPartnerId(String value)
    Sets the partner id associated with this branding asset.
    void
    setPreview(boolean value)
    Sets if true, the asset will be displayed in the merchant portal, but not on merchant terminal hardware.
    void
    setPreviewImage(String value)
    Sets the recommended image to be displayed when rendering a preview of this branding asset.
    void
    setResponseDescription(String value)
    Sets a narrative description of the transaction result.
    void
    setSlideShowId(String value)
    Sets the slide show associated with this branding asset, if any.
    void
    setStartDate(String value)
    Sets the start date if this asset should be displayed based on a schedule.
    void
    setStartTime(String value)
    Sets the start date if this asset should be displayed based on a schedule.
    void
    setSuccess(boolean value)
    Sets whether or not the request succeeded.
    void
    setTerminalGroupId(String value)
    Sets the terminal group id if this branding asset is specific to a terminal group.
    void
    setTerminalId(String value)
    Sets the terminal id if this branding asset is specific to a single terminal.
    void
    setTest(boolean value)
    Sets whether or not to route transaction to the test gateway.
    void
    setThumbnail(String value)
    Sets the fully qualified URL of the thumbnail image for this branding asset.
    void
    setTimeout(int value)
    Sets the request timeout in seconds.
    void
    setUserId(String value)
    Sets id of the user who created this branding asset, if applicable.
    void
    setUserName(String value)
    Sets name of the user who created this branding asset, if applicable.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • BrandingAsset

      public BrandingAsset()

  • Method Details

    • setTimeout

      public void setTimeout(int value)
      Sets the request timeout in seconds.
      Parameters:
      value - the request timeout in seconds.

    • getTimeout

      public int getTimeout()
      Gets the request timeout in seconds.
      Specified by:
      getTimeout in interface ITimeoutRequest
      Returns:
      the request timeout in seconds.

    • setTest

      public void setTest(boolean value)
      Sets whether or not to route transaction to the test gateway.
      Parameters:
      value - whether or not to route transaction to the test gateway.

    • isTest

      public boolean isTest()
      Gets whether or not to route transaction to the test gateway.
      Specified by:
      isTest in interface ITimeoutRequest
      Returns:
      whether or not to route transaction to the test gateway.

    • setSuccess

      public void setSuccess(boolean value)
      Sets whether or not the request succeeded.
      Parameters:
      value - whether or not the request succeeded.

    • isSuccess

      public boolean isSuccess()
      Gets whether or not the request succeeded.
      Specified by:
      isSuccess in interface IAbstractAcknowledgement
      Returns:
      whether or not the request succeeded.

    • setError

      public void setError(String value)
      Sets the error, if an error occurred.
      Parameters:
      value - the error, if an error occurred.

    • getError

      public String getError()
      Gets the error, if an error occurred.
      Specified by:
      getError in interface IAbstractAcknowledgement
      Returns:
      the error, if an error occurred.

    • setResponseDescription

      public void setResponseDescription(String value)
      Sets a narrative description of the transaction result.
      Parameters:
      value - a narrative description of the transaction result.

    • getResponseDescription

      public String getResponseDescription()
      Gets a narrative description of the transaction result.
      Specified by:
      getResponseDescription in interface IAbstractAcknowledgement
      Returns:
      a narrative description of the transaction result.

    • setId

      public void setId(String value)
      Sets id used to track a branding asset.
      Parameters:
      value - id used to track a branding asset.

    • getId

      public String getId()
      Gets id used to track a branding asset.
      Returns:
      id used to track a branding asset.

    • setOwnerId

      public void setOwnerId(String value)
      Sets the id owner of the tenant who owns the branding asset.
      Parameters:
      value - the id owner of the tenant who owns the branding asset.

    • getOwnerId

      public String getOwnerId()
      Gets the id owner of the tenant who owns the branding asset.
      Returns:
      the id owner of the tenant who owns the branding asset.

    • setTerminalId

      public void setTerminalId(String value)
      Sets the terminal id if this branding asset is specific to a single terminal.
      Parameters:
      value - the terminal id if this branding asset is specific to a single terminal.

    • getTerminalId

      public String getTerminalId()
      Gets the terminal id if this branding asset is specific to a single terminal.
      Returns:
      the terminal id if this branding asset is specific to a single terminal.

    • setTerminalGroupId

      public void setTerminalGroupId(String value)
      Sets the terminal group id if this branding asset is specific to a terminal group.
      Parameters:
      value - the terminal group id if this branding asset is specific to a terminal group.

    • getTerminalGroupId

      public String getTerminalGroupId()
      Gets the terminal group id if this branding asset is specific to a terminal group.
      Returns:
      the terminal group id if this branding asset is specific to a terminal group.

    • setMerchantId

      public void setMerchantId(String value)
      Sets the merchant id associated with this branding asset.
      Parameters:
      value - the merchant id associated with this branding asset.

    • getMerchantId

      public String getMerchantId()
      Gets the merchant id associated with this branding asset.
      Returns:
      the merchant id associated with this branding asset.

    • setOrganizationId

      public void setOrganizationId(String value)
      Sets the organization id associated with this branding asset.
      Parameters:
      value - the organization id associated with this branding asset.

    • getOrganizationId

      public String getOrganizationId()
      Gets the organization id associated with this branding asset.
      Returns:
      the organization id associated with this branding asset.

    • setPartnerId

      public void setPartnerId(String value)
      Sets the partner id associated with this branding asset.
      Parameters:
      value - the partner id associated with this branding asset.

    • getPartnerId

      public String getPartnerId()
      Gets the partner id associated with this branding asset.
      Returns:
      the partner id associated with this branding asset.

    • setSlideShowId

      public void setSlideShowId(String value)
      Sets the slide show associated with this branding asset, if any.
      Parameters:
      value - the slide show associated with this branding asset, if any. A branding asset can reference a slide show or media asset, but not both.

    • getSlideShowId

      public String getSlideShowId()
      Gets the slide show associated with this branding asset, if any.
      Returns:
      the slide show associated with this branding asset, if any. A branding asset can reference a slide show or media asset, but not both.

    • setMediaId

      public void setMediaId(String value)
      Sets the media id associated with this branding asset, if any.
      Parameters:
      value - the media id associated with this branding asset, if any. A branding asset can reference a slide show or media asset, but not both.

    • getMediaId

      public String getMediaId()
      Gets the media id associated with this branding asset, if any.
      Returns:
      the media id associated with this branding asset, if any. A branding asset can reference a slide show or media asset, but not both.

    • setPadded

      public void setPadded(boolean value)
      Sets applies standard margins to images displayed on terminals.
      Parameters:
      value - applies standard margins to images displayed on terminals. Usually the best option for logos.

    • isPadded

      public boolean isPadded()
      Gets applies standard margins to images displayed on terminals.
      Returns:
      applies standard margins to images displayed on terminals. Usually the best option for logos.

    • setStartDate

      public void setStartDate(String value)
      Sets the start date if this asset should be displayed based on a schedule.
      Parameters:
      value - the start date if this asset should be displayed based on a schedule. Format: MM/DD/YYYY.

    • getStartDate

      public String getStartDate()
      Gets the start date if this asset should be displayed based on a schedule.
      Returns:
      the start date if this asset should be displayed based on a schedule. Format: MM/DD/YYYY.

    • setEndDate

      public void setEndDate(String value)
      Sets the end date if this asset should be displayed based on a schedule.
      Parameters:
      value - the end date if this asset should be displayed based on a schedule. Format: MM/DD/YYYY.

    • getEndDate

      public String getEndDate()
      Gets the end date if this asset should be displayed based on a schedule.
      Returns:
      the end date if this asset should be displayed based on a schedule. Format: MM/DD/YYYY.

    • setDaysOfWeek

      public void setDaysOfWeek(Collection<Weekday> value)
      Sets an array of days of the week during which a branding asset should be enabled.
      Parameters:
      value - an array of days of the week during which a branding asset should be enabled. Days of the week are coded as integers starting with Sunday (0) and ending with Saturday (6).

    • getDaysOfWeek

      public Collection<Weekday> getDaysOfWeek()
      Gets an array of days of the week during which a branding asset should be enabled.
      Returns:
      an array of days of the week during which a branding asset should be enabled. Days of the week are coded as integers starting with Sunday (0) and ending with Saturday (6).

    • setStartTime

      public void setStartTime(String value)
      Sets the start date if this asset should be displayed based on a schedule.
      Parameters:
      value - the start date if this asset should be displayed based on a schedule. Format: MM/DD/YYYY.

    • getStartTime

      public String getStartTime()
      Gets the start date if this asset should be displayed based on a schedule.
      Returns:
      the start date if this asset should be displayed based on a schedule. Format: MM/DD/YYYY.

    • setEndTime

      public void setEndTime(String value)
      Sets the end date if this asset should be displayed based on a schedule.
      Parameters:
      value - the end date if this asset should be displayed based on a schedule. Format: MM/DD/YYYY.

    • getEndTime

      public String getEndTime()
      Gets the end date if this asset should be displayed based on a schedule.
      Returns:
      the end date if this asset should be displayed based on a schedule. Format: MM/DD/YYYY.

    • setOrdinal

      public void setOrdinal(int value)
      Sets the ordinal number marking the position of this asset within the branding stack.
      Parameters:
      value - the ordinal number marking the position of this asset within the branding stack.

    • getOrdinal

      public int getOrdinal()
      Gets the ordinal number marking the position of this asset within the branding stack.
      Returns:
      the ordinal number marking the position of this asset within the branding stack.

    • setEnabled

      public void setEnabled(boolean value)
      Sets enables the asset for display.
      Parameters:
      value - enables the asset for display.

    • isEnabled

      public boolean isEnabled()
      Gets enables the asset for display.
      Returns:
      enables the asset for display.

    • setPreview

      public void setPreview(boolean value)
      Sets if true, the asset will be displayed in the merchant portal, but not on merchant terminal hardware.
      Parameters:
      value - if true, the asset will be displayed in the merchant portal, but not on merchant terminal hardware. Developers will usually want this to always be false.

    • isPreview

      public boolean isPreview()
      Gets if true, the asset will be displayed in the merchant portal, but not on merchant terminal hardware.
      Returns:
      if true, the asset will be displayed in the merchant portal, but not on merchant terminal hardware. Developers will usually want this to always be false.

    • setUserId

      public void setUserId(String value)
      Sets id of the user who created this branding asset, if applicable.
      Parameters:
      value - id of the user who created this branding asset, if applicable.

    • getUserId

      public String getUserId()
      Gets id of the user who created this branding asset, if applicable.
      Returns:
      id of the user who created this branding asset, if applicable.

    • setUserName

      public void setUserName(String value)
      Sets name of the user who created this branding asset, if applicable.
      Parameters:
      value - name of the user who created this branding asset, if applicable.

    • getUserName

      public String getUserName()
      Gets name of the user who created this branding asset, if applicable.
      Returns:
      name of the user who created this branding asset, if applicable.

    • setThumbnail

      public void setThumbnail(String value)
      Sets the fully qualified URL of the thumbnail image for this branding asset.
      Parameters:
      value - the fully qualified URL of the thumbnail image for this branding asset.

    • getThumbnail

      public String getThumbnail()
      Gets the fully qualified URL of the thumbnail image for this branding asset.
      Returns:
      the fully qualified URL of the thumbnail image for this branding asset.

    • setLastModified

      public void setLastModified(String value)
      Sets the time and date this asset was last modified.
      Parameters:
      value - the time and date this asset was last modified.

    • getLastModified

      public String getLastModified()
      Gets the time and date this asset was last modified.
      Returns:
      the time and date this asset was last modified.

    • setNotes

      public void setNotes(String value)
      Sets a field for notes related to a branding asset.
      Parameters:
      value - a field for notes related to a branding asset.

    • getNotes

      public String getNotes()
      Gets a field for notes related to a branding asset.
      Returns:
      a field for notes related to a branding asset.

    • setEditable

      public void setEditable(boolean value)
      Sets if true, the API credentials used to retrieve the branding asset record can be used to update it.
      Parameters:
      value - if true, the API credentials used to retrieve the branding asset record can be used to update it.

    • isEditable

      public boolean isEditable()
      Gets if true, the API credentials used to retrieve the branding asset record can be used to update it.
      Returns:
      if true, the API credentials used to retrieve the branding asset record can be used to update it.

    • setAssetType

      public void setAssetType(String value)
      Sets the type of branding asset.
      Parameters:
      value - the type of branding asset.

    • getAssetType

      public String getAssetType()
      Gets the type of branding asset.
      Returns:
      the type of branding asset.

    • setOwnerType

      public void setOwnerType(String value)
      Sets the type of user or tenant that owns this asset.
      Parameters:
      value - the type of user or tenant that owns this asset.

    • getOwnerType

      public String getOwnerType()
      Gets the type of user or tenant that owns this asset.
      Returns:
      the type of user or tenant that owns this asset.

    • setOwnerTypeCaption

      public void setOwnerTypeCaption(String value)
      Sets a recommended caption for displaying the owner.
      Parameters:
      value - a recommended caption for displaying the owner. Takes into account multiple organization types.

    • getOwnerTypeCaption

      public String getOwnerTypeCaption()
      Gets a recommended caption for displaying the owner.
      Returns:
      a recommended caption for displaying the owner. Takes into account multiple organization types.

    • setOwnerName

      public void setOwnerName(String value)
      Sets the name of the tenant or entity that owns the branding asset.
      Parameters:
      value - the name of the tenant or entity that owns the branding asset.

    • getOwnerName

      public String getOwnerName()
      Gets the name of the tenant or entity that owns the branding asset.
      Returns:
      the name of the tenant or entity that owns the branding asset.

    • setPreviewImage

      public void setPreviewImage(String value)
      Sets the recommended image to be displayed when rendering a preview of this branding asset.
      Parameters:
      value - the recommended image to be displayed when rendering a preview of this branding asset.

    • getPreviewImage

      public String getPreviewImage()
      Gets the recommended image to be displayed when rendering a preview of this branding asset.
      Returns:
      the recommended image to be displayed when rendering a preview of this branding asset.

    • setNarrativeEffectiveDates

      public void setNarrativeEffectiveDates(String value)
      Sets a compact narrative string explaining the effective date and time rules for a branding asset.
      Parameters:
      value - a compact narrative string explaining the effective date and time rules for a branding asset.

    • getNarrativeEffectiveDates

      public String getNarrativeEffectiveDates()
      Gets a compact narrative string explaining the effective date and time rules for a branding asset.
      Returns:
      a compact narrative string explaining the effective date and time rules for a branding asset.

    • setNarrativeDisplayPeriod

      public void setNarrativeDisplayPeriod(String value)
      Sets a compact narrative string explaining the display period for a branding asset.
      Parameters:
      value - a compact narrative string explaining the display period for a branding asset.

    • getNarrativeDisplayPeriod

      public String getNarrativeDisplayPeriod()
      Gets a compact narrative string explaining the display period for a branding asset.
      Returns:
      a compact narrative string explaining the display period for a branding asset.

    • addDaysOfWeek

      public void addDaysOfWeek(Weekday value)
      Adds a an array of days of the week during which a branding asset should be enabled.
      Parameters:
      value - an array of days of the week during which a branding asset should be enabled. Days of the week are coded as integers starting with Sunday (0) and ending with Saturday (6).