Package org.opfab.cards.model

Class Card

java.lang.Object
org.opfab.cards.model.Card
public class Card extends Object
A Card sums up information about the status of a given process instance of the publishing service

  • Constructor Details

    • Card

      public Card()

  • Method Details

    • uid

      public Card uid(String uid)

    • getUid

      public String getUid()
      Unique card ID
      Returns:
      uid

    • setUid

      public void setUid(String uid)

    • id

      public Card id(String id)

    • getId

      public String getId()
      Unique card ID (as defined in the associated process)
      Returns:
      id

    • setId

      public void setId(String id)

    • parentCardId

      public Card parentCardId(String parentCardId)

    • getParentCardId

      public String getParentCardId()
      The id of the parent card if it's a child card (optional)
      Returns:
      parentCardId

    • setParentCardId

      public void setParentCardId(String parentCardId)

    • initialParentCardUid

      public Card initialParentCardUid(String initialParentCardUid)

    • getInitialParentCardUid

      public String getInitialParentCardUid()
      The uid of the initial parent card if it's a child card (optional). When a card is updated, its id is still the same but not its uid, that's why we store this field initialParentCardUid.
      Returns:
      initialParentCardUid

    • setInitialParentCardUid

      public void setInitialParentCardUid(String initialParentCardUid)

    • publisher

      public Card publisher(String publisher)

    • getPublisher

      public String getPublisher()
      Unique ID of the entity or service publishing the card
      Returns:
      publisher

    • setPublisher

      public void setPublisher(String publisher)

    • processVersion

      public Card processVersion(String processVersion)

    • getProcessVersion

      public String getProcessVersion()
      Version of the associated process
      Returns:
      processVersion

    • setProcessVersion

      public void setProcessVersion(String processVersion)

    • process

      public Card process(String process)

    • getProcess

      public String getProcess()
      ID of the associated process
      Returns:
      process

    • setProcess

      public void setProcess(String process)

    • processInstanceId

      public Card processInstanceId(String processInstanceId)

    • getProcessInstanceId

      public String getProcessInstanceId()
      ID of the associated process instance
      Returns:
      processInstanceId

    • setProcessInstanceId

      public void setProcessInstanceId(String processInstanceId)

    • state

      public Card state(String state)

    • getState

      public String getState()
      associated process state name
      Returns:
      state

    • setState

      public void setState(String state)

    • publishDate

      public Card publishDate(Instant publishDate)

    • getPublishDate

      public Instant getPublishDate()
      The date the card was published (meaning created by the card service)
      Returns:
      publishDate

    • setPublishDate

      public void setPublishDate(Instant publishDate)

    • lttd

      public Card lttd(Instant lttd)

    • getLttd

      public Instant getLttd()
      Last time to decide, after this date no action can be triggered on the card
      Returns:
      lttd

    • setLttd

      public void setLttd(Instant lttd)

    • startDate

      public Card startDate(Instant startDate)

    • getStartDate

      public Instant getStartDate()
      Card validity start time
      Returns:
      startDate

    • setStartDate

      public void setStartDate(Instant startDate)

    • endDate

      public Card endDate(Instant endDate)

    • getEndDate

      public Instant getEndDate()
      Card validity end time (must be after startDate)
      Returns:
      endDate

    • setEndDate

      public void setEndDate(Instant endDate)

    • expirationDate

      public Card expirationDate(Instant expirationDate)

    • getExpirationDate

      public Instant getExpirationDate()
      Card deletion time (must be after startDate)
      Returns:
      expirationDate

    • setExpirationDate

      public void setExpirationDate(Instant expirationDate)

    • severity

      public Card severity(SeverityEnum severity)

    • getSeverity

      public SeverityEnum getSeverity()
      Card severity
      Returns:
      severity

    • setSeverity

      public void setSeverity(SeverityEnum severity)

    • tags

      public Card tags(List<String> tags)

    • addTagsItem

      public Card addTagsItem(String tagsItem)

    • getTags

      public List<String> getTags()
      Tags associated with the card
      Returns:
      tags

    • setTags

      public void setTags(List<String> tags)

    • rRule

      public Card rRule(RRule rRule)

    • getRRule

      public RRule getRRule()
      Json object representing the recurrence of the card (as defined in the RFC 5545)
      Returns:
      rRule

    • setRRule

      public void setRRule(RRule rRule)

    • timeSpans

      public Card timeSpans(List<TimeSpan> timeSpans)

    • addTimeSpansItem

      public Card addTimeSpansItem(TimeSpan timeSpansItem)

    • getTimeSpans

      public List<TimeSpan> getTimeSpans()
      List of business time span associated to card
      Returns:
      timeSpans

    • setTimeSpans

      public void setTimeSpans(List<TimeSpan> timeSpans)

    • title

      public Card title(I18n title)

    • getTitle

      public I18n getTitle()
      Card i18n title
      Returns:
      title

    • setTitle

      public void setTitle(I18n title)

    • summary

      public Card summary(I18n summary)

    • getSummary

      public I18n getSummary()
      Card i18n summary
      Returns:
      summary

    • setSummary

      public void setSummary(I18n summary)

    • titleTranslated

      public Card titleTranslated(String titleTranslated)

    • getTitleTranslated

      public String getTitleTranslated()
      Card title translated
      Returns:
      titleTranslated

    • setTitleTranslated

      public void setTitleTranslated(String titleTranslated)

    • summaryTranslated

      public Card summaryTranslated(String summaryTranslated)

    • getSummaryTranslated

      public String getSummaryTranslated()
      Card summary translated
      Returns:
      summaryTranslated

    • setSummaryTranslated

      public void setSummaryTranslated(String summaryTranslated)

    • userRecipients

      public Card userRecipients(List<String> userRecipients)

    • addUserRecipientsItem

      public Card addUserRecipientsItem(String userRecipientsItem)

    • getUserRecipients

      public List<String> getUserRecipients()
      List of user recipients
      Returns:
      userRecipients

    • setUserRecipients

      public void setUserRecipients(List<String> userRecipients)

    • groupRecipients

      public Card groupRecipients(List<String> groupRecipients)

    • addGroupRecipientsItem

      public Card addGroupRecipientsItem(String groupRecipientsItem)

    • getGroupRecipients

      public List<String> getGroupRecipients()
      List of group recipients
      Returns:
      groupRecipients

    • setGroupRecipients

      public void setGroupRecipients(List<String> groupRecipients)

    • externalRecipients

      public Card externalRecipients(List<String> externalRecipients)

    • addExternalRecipientsItem

      public Card addExternalRecipientsItem(String externalRecipientsItem)

    • getExternalRecipients

      public List<String> getExternalRecipients()
      List of external recipients
      Returns:
      externalRecipients

    • setExternalRecipients

      public void setExternalRecipients(List<String> externalRecipients)

    • entitiesAllowedToRespond

      public Card entitiesAllowedToRespond(List<String> entitiesAllowedToRespond)

    • addEntitiesAllowedToRespondItem

      public Card addEntitiesAllowedToRespondItem(String entitiesAllowedToRespondItem)

    • getEntitiesAllowedToRespond

      public List<String> getEntitiesAllowedToRespond()
      List of entities that can respond
      Returns:
      entitiesAllowedToRespond

    • setEntitiesAllowedToRespond

      public void setEntitiesAllowedToRespond(List<String> entitiesAllowedToRespond)

    • entitiesRequiredToRespond

      public Card entitiesRequiredToRespond(List<String> entitiesRequiredToRespond)

    • addEntitiesRequiredToRespondItem

      public Card addEntitiesRequiredToRespondItem(String entitiesRequiredToRespondItem)

    • getEntitiesRequiredToRespond

      public List<String> getEntitiesRequiredToRespond()
      List of entities that have to respond. It will be taken into account in addition to entitiesAllowedToRespond to determine if a user can send a response. If present and not empty, this list will be used for display in the card detail header instead of entitiesAllowedToRespond.
      Returns:
      entitiesRequiredToRespond

    • setEntitiesRequiredToRespond

      public void setEntitiesRequiredToRespond(List<String> entitiesRequiredToRespond)

    • entityRecipients

      public Card entityRecipients(List<String> entityRecipients)

    • addEntityRecipientsItem

      public Card addEntityRecipientsItem(String entityRecipientsItem)

    • getEntityRecipients

      public List<String> getEntityRecipients()
      List of entity recipients
      Returns:
      entityRecipients

    • setEntityRecipients

      public void setEntityRecipients(List<String> entityRecipients)

    • entityRecipientsForInformation

      public Card entityRecipientsForInformation(List<String> entityRecipientsForInformation)

    • addEntityRecipientsForInformationItem

      public Card addEntityRecipientsForInformationItem(String entityRecipientsForInformationItem)

    • getEntityRecipientsForInformation

      public List<String> getEntityRecipientsForInformation()
      List of entity recipients for information : Among entityRecipients which one are only for information.
      Returns:
      entityRecipientsForInformation

    • setEntityRecipientsForInformation

      public void setEntityRecipientsForInformation(List<String> entityRecipientsForInformation)

    • entitiesAllowedToEdit

      public Card entitiesAllowedToEdit(List<String> entitiesAllowedToEdit)

    • addEntitiesAllowedToEditItem

      public Card addEntitiesAllowedToEditItem(String entitiesAllowedToEditItem)

    • getEntitiesAllowedToEdit

      public List<String> getEntitiesAllowedToEdit()
      List of entities that can edit the card
      Returns:
      entitiesAllowedToEdit

    • setEntitiesAllowedToEdit

      public void setEntitiesAllowedToEdit(List<String> entitiesAllowedToEdit)

    • data

      public Card data(Object data)

    • getData

      public Object getData()
      Business data
      Returns:
      data

    • setData

      public void setData(Object data)

    • hasBeenAcknowledged

      public Card hasBeenAcknowledged(Boolean hasBeenAcknowledged)

    • getHasBeenAcknowledged

      public Boolean getHasBeenAcknowledged()
      Is true if the card was acknowledged by current user
      Returns:
      hasBeenAcknowledged

    • setHasBeenAcknowledged

      public void setHasBeenAcknowledged(Boolean hasBeenAcknowledged)

    • entitiesAcks

      public Card entitiesAcks(List<String> entitiesAcks)

    • addEntitiesAcksItem

      public Card addEntitiesAcksItem(String entitiesAcksItem)

    • getEntitiesAcks

      public List<String> getEntitiesAcks()
      List of entities that acknowledged the card
      Returns:
      entitiesAcks

    • setEntitiesAcks

      public void setEntitiesAcks(List<String> entitiesAcks)

    • hasBeenRead

      public Card hasBeenRead(Boolean hasBeenRead)

    • getHasBeenRead

      public Boolean getHasBeenRead()
      Is true if the card was read by current user
      Returns:
      hasBeenRead

    • setHasBeenRead

      public void setHasBeenRead(Boolean hasBeenRead)

    • publisherType

      public Card publisherType(PublisherTypeEnum publisherType)

    • getPublisherType

      public PublisherTypeEnum getPublisherType()
      Get publisherType
      Returns:
      publisherType

    • setPublisherType

      public void setPublisherType(PublisherTypeEnum publisherType)

    • representative

      public Card representative(String representative)

    • getRepresentative

      public String getRepresentative()
      Used in case of sending card as a representative of an entity or a publisher (unique ID of the entity or publisher)
      Returns:
      representative

    • setRepresentative

      public void setRepresentative(String representative)

    • representativeType

      public Card representativeType(PublisherTypeEnum representativeType)

    • getRepresentativeType

      public PublisherTypeEnum getRepresentativeType()
      Get representativeType
      Returns:
      representativeType

    • setRepresentativeType

      public void setRepresentativeType(PublisherTypeEnum representativeType)

    • wktGeometry

      public Card wktGeometry(String wktGeometry)

    • getWktGeometry

      public String getWktGeometry()
      Contains WKT geometry string ex. 'POINT (6.476709 52.569132)'
      Returns:
      wktGeometry

    • setWktGeometry

      public void setWktGeometry(String wktGeometry)

    • wktProjection

      public Card wktProjection(String wktProjection)

    • getWktProjection

      public String getWktProjection()
      Contains projection ex. 'EPSG:4326'
      Returns:
      wktProjection

    • setWktProjection

      public void setWktProjection(String wktProjection)

    • secondsBeforeTimeSpanForReminder

      public Card secondsBeforeTimeSpanForReminder(Integer secondsBeforeTimeSpanForReminder)

    • getSecondsBeforeTimeSpanForReminder

      public Integer getSecondsBeforeTimeSpanForReminder()
      Get secondsBeforeTimeSpanForReminder minimum: 0
      Returns:
      secondsBeforeTimeSpanForReminder

    • setSecondsBeforeTimeSpanForReminder

      public void setSecondsBeforeTimeSpanForReminder(Integer secondsBeforeTimeSpanForReminder)

    • actions

      public Card actions(List<CardActionEnum> actions)

    • addActionsItem

      public Card addActionsItem(CardActionEnum actionsItem)

    • getActions

      public List<CardActionEnum> getActions()
      Get actions
      Returns:
      actions

    • setActions

      public void setActions(List<CardActionEnum> actions)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object