FrameworkPackage (harbormaster 1.2 API)

java.lang.Object
- com.harbormaster.foundational.common.FrameworkBaseObject
- - com.harbormaster.foundational.business.bo.FrameworkHibernateBusinessObject
  - - com.harbormaster.entity.Base
    - - com.harbormaster.entity.BaseTransactionalEntity
      - com.harbormaster.entity.FrameworkPackage

All Implemented Interfaces:

IFrameworkBaseObject, Serializable
```
public class FrameworkPackage
extends BaseTransactionalEntity
```
Encapsulates data for a Technology Stack Package, to mimic a portion of the framework-package.xml file.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`appType`
`protected String`	`derivedFrom`
`protected String`	`iconUrl`
`protected String`	`infoPageUrl`
`protected String`	`localZipFilePath`
`protected String`	`packageXML`
`protected String`	`releaseStatus`
`protected String`	`shortName`
`protected boolean`	`supportsDocker`
`protected boolean`	`supportsKubernetes`
`protected String`	`version`
`protected boolean`	`visible`

Fields inherited from class com.harbormaster.entity.BaseTransactionalEntity
checkSum, cost, DATE_TIME_FORMAT, dateTime, deleted, description, filePath, name, ownerId, scopeType

Fields inherited from class com.harbormaster.entity.Base
id

Fields inherited from class com.harbormaster.foundational.common.FrameworkBaseObject
serialVersionUID

Constructor Summary

Constructors
Constructor and Description

FrameworkPackage()
Default Constructor

FrameworkPackage(FrameworkPackage object)
Constructor with a FrameworkPackage

Constructors
Constructor and Description
`FrameworkPackage()` Default Constructor
`FrameworkPackage(FrameworkPackage object)` Constructor with a FrameworkPackage

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`copy(FrameworkPackage object)` Performs a deep copy which is a shallow copy but includes member attributes that behave as associations to other classes.
`boolean`	`equals(Object object)` Comparison method to determine if the provided object is equivalent to this instance.
`String`	`getAppType()` Returns the appType field.
`String`	`getDerivedFrom()` Returns the derivedFrom field.
`String`	`getIconUrl()` Returns the iconUrl field.
`String`	`getInfoPageUrl()` Returns the infoPageUrl field.
`String`	`getLocalZipFilePath()` Returns the localZipFilePath field.
`String`	`getObjectType()` Returns the type of this object.
`String`	`getPackageXML()` Returns the packageXML field.
`String`	`getReleaseStatus()` Returns the releaseStatus field.
`String`	`getShortName()` Returns the shortName field.
`boolean`	`getSupportsDocker()` Returns the supportsDocker field.
`boolean`	`getSupportsKubernetes()` Returns the supportsKubernetes field.
`String`	`getVersion()` Returns the version field.
`boolean`	`getVisible()` Returns the visible field.
`int`	`hashCode()`
`void`	`setAppType(String appType)` Assigns the appType field using the provided argument.
`void`	`setDerivedFrom(String derivedFrom)` Assigns the derivedFrom field.
`void`	`setIconUrl(String iconUrl)` Assigns the iconUrl field.
`void`	`setInfoPageUrl(String infoPageUrl)` Assigns the infoPageUrl field using the provided argument.
`void`	`setLocalZipFilePath(String localZipFilePath)` Assigns the localZipFilePath field using the provided argument.
`void`	`setPackageXML(String packageXML)` Assigns the packageXML field using the provided argument.
`void`	`setReleaseStatus(String releaseStatus)` Assigns the releaseStatus field using the provided argument.
`void`	`setShortName(String name)` Assigns the shortName field using the provided argument.
`void`	`setSupportsDocker(boolean supportsDocker)` Assigns the supportsDocker field.
`void`	`setSupportsKubernetes(boolean supportsKubernetes)` Assigns the supportsKubernetes field.
`void`	`setVersion(String version)` Assigns the version field using the provided argument.
`void`	`setVisible(boolean visible)` Assigns the visible field.
`void`	`shallowCopy(FrameworkPackage object)` Performs a shallow copy of intrinsic and enumerated types only.
`String`	`toString()` Returns a string representation of the object.

Methods inherited from class com.harbormaster.entity.BaseTransactionalEntity
assignDateTimeToNow, copy, getCheckSum, getCost, getDateTime, getDeleted, getDescription, getFilePath, getName, getOwnerId, getSaveParams, getScopeType, setCheckSum, setCost, setDateTime, setDeleted, setDescription, setFilePath, setName, setOwnerId, setScopeType, shallowCopy

Methods inherited from class com.harbormaster.entity.Base
getId, getIdentity, setId

Methods inherited from class com.harbormaster.foundational.common.FrameworkBaseObject
logDebugMessage, logErrorMessage, logInfoMessage, logMessage, logWarnMessage

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - shortName
```
protected String shortName
```
  - version
```
protected String version
```
  - infoPageUrl
```
protected String infoPageUrl
```
  - releaseStatus
```
protected String releaseStatus
```
  - appType
```
protected String appType
```
  - packageXML
```
protected String packageXML
```
  - iconUrl
```
protected String iconUrl
```
  - localZipFilePath
```
protected String localZipFilePath
```
  - derivedFrom
```
protected String derivedFrom
```
  - visible
```
protected boolean visible
```
  - supportsDocker
```
protected boolean supportsDocker
```
  - supportsKubernetes
```
protected boolean supportsKubernetes
```
- Constructor Detail
  - FrameworkPackage
```
public FrameworkPackage()
```
    Default Constructor
  - FrameworkPackage
```
public FrameworkPackage(FrameworkPackage object)
```
    Constructor with a FrameworkPackage
    
    Parameters:
    
    object - copy source
- Method Detail
  - getShortName
```
public String getShortName()
```
    Returns the shortName field.
    
    Returns:
    
    short name
  - setShortName
```
public void setShortName(String name)
```
    Assigns the shortName field using the provided argument.
    
    Parameters:
    
    name - short name
  - getVersion
```
public String getVersion()
```
    Returns the version field.
    
    Returns:
    
    version
  - setVersion
```
public void setVersion(String version)
```
    Assigns the version field using the provided argument.
    
    Parameters:
    
    version - technology stack package version
  - getAppType
```
public String getAppType()
```
    Returns the appType field. This is the server directory location for this package.
    
    Returns:
    
    application type
  - setAppType
```
public void setAppType(String appType)
```
    Assigns the appType field using the provided argument.
    
    Parameters:
    
    appType - application type
  - getReleaseStatus
```
public String getReleaseStatus()
```
    Returns the releaseStatus field.
    
    Returns:
    
    release status
  - setReleaseStatus
```
public void setReleaseStatus(String releaseStatus)
```
    Assigns the releaseStatus field using the provided argument.
    
    Parameters:
    
    releaseStatus - the release status
  - getInfoPageUrl
```
public String getInfoPageUrl()
```
    Returns the infoPageUrl field.
    
    Returns:
    
    information page URL
  - setInfoPageUrl
```
public void setInfoPageUrl(String infoPageUrl)
```
    Assigns the infoPageUrl field using the provided argument.
    
    Parameters:
    
    infoPageUrl - information page URL
  - getPackageXML
```
public String getPackageXML()
```
    Returns the packageXML field.
    
    Returns:
    
    package content as XML
  - setPackageXML
```
public void setPackageXML(String packageXML)
```
    Assigns the packageXML field using the provided argument.
    
    Parameters:
    
    packageXML - package content as XML
  - getLocalZipFilePath
```
public String getLocalZipFilePath()
```
    Returns the localZipFilePath field.
    
    Returns:
    
    zip file path on local file system
  - setLocalZipFilePath
```
public void setLocalZipFilePath(String localZipFilePath)
```
    Assigns the localZipFilePath field using the provided argument.
    
    Parameters:
    
    localZipFilePath - zip filepath on local file system
  - getIconUrl
```
public String getIconUrl()
```
    Returns the iconUrl field.
    
    Returns:
    
    icon Url
  - setIconUrl
```
public void setIconUrl(String iconUrl)
```
    Assigns the iconUrl field.
    
    Parameters:
    
    iconUrl - package icon Url
  - getDerivedFrom
```
public String getDerivedFrom()
```
    Returns the derivedFrom field.
    
    Returns:
    
    derived from
  - setDerivedFrom
```
public void setDerivedFrom(String derivedFrom)
```
    Assigns the derivedFrom field.
    
    Parameters:
    
    derivedFrom - dervied from
  - getVisible
```
public boolean getVisible()
```
    Returns the visible field.
    
    Returns:
    
    visible
  - setVisible
```
public void setVisible(boolean visible)
```
    Assigns the visible field.
    
    Parameters:
    
    visible - visibility flag
  - getSupportsDocker
```
public boolean getSupportsDocker()
```
    Returns the supportsDocker field.
    
    Returns:
    
    supportsDocker
  - setSupportsDocker
```
public void setSupportsDocker(boolean supportsDocker)
```
    Assigns the supportsDocker field.
    
    Parameters:
    
    supportsDocker - docker usage flag
  - getSupportsKubernetes
```
public boolean getSupportsKubernetes()
```
    Returns the supportsKubernetes field.
    
    Returns:
    
    supportsDocker
  - setSupportsKubernetes
```
public void setSupportsKubernetes(boolean supportsKubernetes)
```
    Assigns the supportsKubernetes field.
    
    Parameters:
    
    supportsKubernetes - kubernetes usage flag
  - shallowCopy
```
public void shallowCopy(FrameworkPackage object)
```
    Performs a shallow copy of intrinsic and enumerated types only.
    
    Parameters:
    
    object - FrameworkPackage copy source
  - copy
```
public void copy(FrameworkPackage object)
```
    Performs a deep copy which is a shallow copy but includes member attributes that behave as associations to other classes.
    
    Parameters:
    
    object - FrameworkPackage copy source
  - toString
```
public String toString()
```
    Description copied from class: BaseTransactionalEntity
    
    Returns a string representation of the object.
    
    Overrides:
    
    toString in class BaseTransactionalEntity
    
    Returns:
    
    String
  - getObjectType
```
public String getObjectType()
```
    Description copied from class: BaseTransactionalEntity
    
    Returns the type of this object.
    
    Overrides:
    
    getObjectType in class BaseTransactionalEntity
    
    Returns:
    
    String
  - equals
```
public boolean equals(Object object)
```
    Description copied from class: Base
    
    Comparison method to determine if the provided object is equivalent to this instance. It does so by ensuring it is non-null, of User type, and the id fields are equivalent.
    
    Overrides:
    
    equals in class BaseTransactionalEntity
    
    Returns:
    
    boolean
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class BaseTransactionalEntity

Class FrameworkPackage

Field Summary

Fields inherited from class com.harbormaster.entity.BaseTransactionalEntity

Fields inherited from class com.harbormaster.entity.Base

Fields inherited from class com.harbormaster.foundational.common.FrameworkBaseObject

Constructor Summary

Method Summary

Methods inherited from class com.harbormaster.entity.BaseTransactionalEntity

Methods inherited from class com.harbormaster.entity.Base

Methods inherited from class com.harbormaster.foundational.common.FrameworkBaseObject

Methods inherited from class java.lang.Object

Field Detail

shortName

version

infoPageUrl

releaseStatus

appType

packageXML

iconUrl

localZipFilePath

derivedFrom

visible

supportsDocker

supportsKubernetes

Constructor Detail

FrameworkPackage

FrameworkPackage

Method Detail

getShortName

setShortName

getVersion

setVersion

getAppType

setAppType

getReleaseStatus

setReleaseStatus

getInfoPageUrl

setInfoPageUrl

getPackageXML

setPackageXML

getLocalZipFilePath

setLocalZipFilePath

getIconUrl

setIconUrl

getDerivedFrom

setDerivedFrom

getVisible

setVisible

getSupportsDocker

setSupportsDocker

getSupportsKubernetes

setSupportsKubernetes

shallowCopy

copy

toString

getObjectType

equals

hashCode