BusinessObjectFormat (herd docs javadoc 0.38.0 API)

java.lang.Object
- org.finra.herd.sdk.model.BusinessObjectFormat

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-02-24T15:10:39.441-05:00")
public class BusinessObjectFormat
extends Object

Constructor Summary

Constructors
Constructor and Description

BusinessObjectFormat()

Constructors
Constructor and Description
`BusinessObjectFormat()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`List<AttributeDefinition>`	`getAttributeDefinitions()` List of attribute definitions (for storage of custom user-defined metadata with objects) which are required to be specified\n when registering Business Object Data against this format.
`List<Attribute>`	`getAttributes()` Custom user-defined metadata associated with this Business Object Format.
`String`	`getBusinessObjectDefinitionName()` The name of the Business Object Definition to which a Business Object Format is related
`String`	`getBusinessObjectFormatFileType()` A File Type known to the system that describes the file type of data stored under a Business Object Format
`String`	`getBusinessObjectFormatUsage()` The Usage of this Business Object Format - a string describing how this format is used.
`Integer`	`getBusinessObjectFormatVersion()` The numeric version of a Business Object Format.
`String`	`getDescription()` Description of the Business Object Format
`Integer`	`getId()` The internal identifier that uniquely identifies a Business Object Format
`Boolean`	`getLatestVersion()` A Y/N flag that shows whether this instance of format is the latest or not.
`String`	`getNamespace()` The Namespace to which a Business Object Format is related
`String`	`getPartitionKey()` The partition key for this Business Object Format
`Schema`	`getSchema()` The schema associated with this Business Object Format
`int`	`hashCode()`
`void`	`setAttributeDefinitions(List<AttributeDefinition> attributeDefinitions)`
`void`	`setAttributes(List<Attribute> attributes)`
`void`	`setBusinessObjectDefinitionName(String businessObjectDefinitionName)`
`void`	`setBusinessObjectFormatFileType(String businessObjectFormatFileType)`
`void`	`setBusinessObjectFormatUsage(String businessObjectFormatUsage)`
`void`	`setBusinessObjectFormatVersion(Integer businessObjectFormatVersion)`
`void`	`setDescription(String description)`
`void`	`setId(Integer id)`
`void`	`setLatestVersion(Boolean latestVersion)`
`void`	`setNamespace(String namespace)`
`void`	`setPartitionKey(String partitionKey)`
`void`	`setSchema(Schema schema)`
`String`	`toString()`

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

- Constructor Detail
  - BusinessObjectFormat
```
public BusinessObjectFormat()
```
- Method Detail
  - getId
```
public Integer getId()
```
    The internal identifier that uniquely identifies a Business Object Format
  - setId
```
public void setId(Integer id)
```
  - getNamespace
```
public String getNamespace()
```
    The Namespace to which a Business Object Format is related
  - setNamespace
```
public void setNamespace(String namespace)
```
  - getBusinessObjectDefinitionName
```
public String getBusinessObjectDefinitionName()
```
    The name of the Business Object Definition to which a Business Object Format is related
  - setBusinessObjectDefinitionName
```
public void setBusinessObjectDefinitionName(String businessObjectDefinitionName)
```
  - getBusinessObjectFormatUsage
```
public String getBusinessObjectFormatUsage()
```
    The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business\n Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object\n Definitions
  - setBusinessObjectFormatUsage
```
public void setBusinessObjectFormatUsage(String businessObjectFormatUsage)
```
  - getBusinessObjectFormatFileType
```
public String getBusinessObjectFormatFileType()
```
    A File Type known to the system that describes the file type of data stored under a Business Object Format
  - setBusinessObjectFormatFileType
```
public void setBusinessObjectFormatFileType(String businessObjectFormatFileType)
```
  - getBusinessObjectFormatVersion
```
public Integer getBusinessObjectFormatVersion()
```
    The numeric version of a Business Object Format. Each time a format is registered, the new version will be the previous version\n + 1
  - setBusinessObjectFormatVersion
```
public void setBusinessObjectFormatVersion(Integer businessObjectFormatVersion)
```
  - getLatestVersion
```
public Boolean getLatestVersion()
```
    A Y/N flag that shows whether this instance of format is the latest or not. Once a new version of format is registered, any\n previous versions will no longer be the latest
  - setLatestVersion
```
public void setLatestVersion(Boolean latestVersion)
```
  - getPartitionKey
```
public String getPartitionKey()
```
    The partition key for this Business Object Format
  - setPartitionKey
```
public void setPartitionKey(String partitionKey)
```
  - getDescription
```
public String getDescription()
```
    Description of the Business Object Format
  - setDescription
```
public void setDescription(String description)
```
  - getAttributes
```
public List<Attribute> getAttributes()
```
    Custom user-defined metadata associated with this Business Object Format. \"name\" is the attribute name (i.e. the key) and\n \"value\" is the attribute value.
  - setAttributes
```
public void setAttributes(List<Attribute> attributes)
```
  - getAttributeDefinitions
```
public List<AttributeDefinition> getAttributeDefinitions()
```
    List of attribute definitions (for storage of custom user-defined metadata with objects) which are required to be specified\n when registering Business Object Data against this format. This list will define which metadata must be specified, but additional metadata can\n still be registered which is not specified in this list. The metadata (attributes) will allow applications to store custom data with\n registered data for use by consumers of the data
  - setAttributeDefinitions
```
public void setAttributeDefinitions(List<AttributeDefinition> attributeDefinitions)
```
  - getSchema
```
public Schema getSchema()
```
    The schema associated with this Business Object Format
  - setSchema
```
public void setSchema(Schema schema)
```
  - 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

Class BusinessObjectFormat

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BusinessObjectFormat

Method Detail

getId

setId

getNamespace

setNamespace

getBusinessObjectDefinitionName

setBusinessObjectDefinitionName

getBusinessObjectFormatUsage

setBusinessObjectFormatUsage

getBusinessObjectFormatFileType

setBusinessObjectFormatFileType

getBusinessObjectFormatVersion

setBusinessObjectFormatVersion

getLatestVersion

setLatestVersion

getPartitionKey

setPartitionKey

getDescription

setDescription

getAttributes

setAttributes

getAttributeDefinitions

setAttributeDefinitions

getSchema

setSchema

equals

hashCode

toString