Package org.onehippo.cms7.services.project

Class Project

java.lang.Object
org.onehippo.cms7.services.project.Project
public class Project extends Object

  • Constructor Details

    • Project

      public Project()

  • Method Details

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getProjectState

      public ProjectState getProjectState()

    • setProjectState

      public void setProjectState(ProjectState projectState)

    • getLocalizedState

      public String getLocalizedState()

    • setLocalizedState

      public void setLocalizedState(String localizedState)

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • getExternalId

      public String getExternalId()

    • setExternalId

      public void setExternalId(String externalId)

    • getLastModifiedBy

      public String getLastModifiedBy()

    • setLastModifiedBy

      public void setLastModifiedBy(String lastModifiedBy)

    • setLastModificationDate

      @Deprecated public void setLastModificationDate(long lastModificationDate)
      Deprecated.
      Use getLastModifiedAt() instead
      Sets the last modified timestamp (unix epoch milliseconds) of the project.
      Parameters:
      lastModificationDate - unix epoch milliseconds of last project modification

    • getLastModificationDate

      @Deprecated public long getLastModificationDate()
      Deprecated.
      Use getLastModifiedAt() instead
      Returns the last modified timestamp (unix epoch milliseconds) of the project.
      Returns:
      the last modified timestamp (as unix epoch millis)

    • getLastModifiedAt

      public Calendar getLastModifiedAt()
      Returns the last modified timestamp of the project.
      Returns:
      the last modified timestamp

    • setLastModifiedAt

      public void setLastModifiedAt(Calendar lastModifiedAt)
      Sets the last modified timestamp of the project.
      Parameters:
      lastModifiedAt - timestamp of last project modification

    • getBusinessKey

      public String getBusinessKey()

    • setBusinessKey

      public void setBusinessKey(String businessKey)

    • getJsonReintegrationResult

      public String getJsonReintegrationResult()

    • setJsonReintegrationResult

      public void setJsonReintegrationResult(String jsonReintegrationResult)

    • getJsonUpdateResult

      public String getJsonUpdateResult()

    • setJsonUpdateResult

      public void setJsonUpdateResult(String jsonUpdateResult)

    • getStartRunningAt

      @Deprecated public Long getStartRunningAt()
      Deprecated.
      Use getStartRunningFrom() instead
      Returns the timestamp (unix epoch milliseconds) at which the project can start running.
      Returns:
      when the project can start running

    • getStartRunningFrom

      public Calendar getStartRunningFrom()
      Returns the timestamp at which the project can start running.
      Returns:
      when the project can start running

    • setStartRunningAt

      @Deprecated public void setStartRunningAt(Long startRunningAt)
      Deprecated.
      Use setStartRunningFrom(Calendar) instead
      Sets the timestamp (unix epoch milliseconds) at which the project can start running.
      Parameters:
      startRunningAt - when the project can start running

    • setStartRunningFrom

      public void setStartRunningFrom(Calendar startRunningFrom)
      Sets the timestamp at which the project can start running.
      Parameters:
      startRunningFrom - when the project can start running

    • getStopRunningAt

      @Deprecated public Long getStopRunningAt()
      Deprecated.
      Use getStopRunningAfter() instead
      Returns the timestamp (unix epoch milliseconds) after which the project will no longer run.
      Returns:
      when the project will no longer run

    • getStopRunningAfter

      public Calendar getStopRunningAfter()
      Returns the timestamp (unix epoch milliseconds) after which the project will no longer run.
      Returns:
      when the project will no longer run

    • setStopRunningAt

      @Deprecated public void setStopRunningAt(Long stopRunningAt)
      Deprecated.
      Use setStopRunningAfter(Calendar) ()} instead
      Sets the timestamp (unix epoch milliseconds) after which the project will no longer run.
      Parameters:
      stopRunningAt - when the project will no longer run

    • setStopRunningAfter

      public void setStopRunningAfter(Calendar stopRunningAfter)
      Sets the timestamp after which the project will no longer run.
      Parameters:
      stopRunningAfter - when the project will no longer run

    • isRunnableAt

      public boolean isRunnableAt(long timestampEpochMillis)
      Returns true if this project can be used for rendering the project's items in a website at the given instant in time, returns false otherwise. When a project starts running it's state transitions from APPROVED to START_RUNNING and then to RUNNING. This method does however NOT take the project state into account, so it should NOT be used for testing RUNNING eligibility. This is on purpose! The method can be used to test if a project is runnable at a certain point in time (either now, the future or the past). If you want to know if it is running NOW, then you should test the state.
      Parameters:
      timestampEpochMillis - an instant in time
      Returns:
      if the project is runnable.

    • toString

      public String toString()
      Overrides:
      toString in class Object