Common Domain UNUSED::UNUSED Packages::TIP Common ABE::Management Job ABE
Class FileTransferData

Defines the information required for a file based data transfer.

Attributes
CompressionType compressionType compressionType

The type of compression to apply to the generated file(s).

Default behavior (when request parameter is omitted) is NO_COMPRESSION.

Implementation of this file processing instruction by the Target OS is optional, and any incompatible request shall be handled with the appropriate exception. Vendor extension of this attribute is permitted, the value EXTENSION is used to indicate it.

String fileFormat fileFormat

Defines the format of the files.

«baseType» URI fileLocation fileLocation

URI provided by the requesting OS indicating the rootname of the file(s) to be produced and location of where to place the retrieved file(s).

PackingType packingType packingType

The type of packing to apply to all the file(s) generated from the same request.

Default behavior (when request parameter is omitted) is NO_ PACKING.

Implementation of this file processing instruction by the Target OS is optional, and any incompatible request shall be handled with the appropriate exception. Vendor extension of this attribute is permitted, the value EXTENSION is used to indicate it.

«baseType» Duration retentionPeriod retentionPeriod

The maximum duration the files produced by this job will be retained on the producing OS.

Attributes inherited from SID Models::Common Domain UNUSED::UNUSED Packages::TIP Common ABE::Management Job ABE::ProtocolTransferData SID Models::Common Domain UNUSED::UNUSED Packages::TIP Common ABE::Management Job ABE::ProtocolTransferData
transportProtocol transportProtocol, job job

Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
KeywordsdataType
NameFileTransferData
Name Expression
NamespaceManagement Job ABE
Owned Template Signature
OwnerManagement Job ABE
Owning Template Parameter
PackageManagement Job ABE
Qualified NameSID Models::Common Domain UNUSED::UNUSED Packages::TIP Common ABE::Management Job ABE::FileTransferData
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 compressionType
Public CompressionType compressionType

The type of compression to apply to the generated file(s).

Default behavior (when request parameter is omitted) is NO_COMPRESSION.

Implementation of this file processing instruction by the Target OS is optional, and any incompatible request shall be handled with the appropriate exception. Vendor extension of this attribute is permitted, the value EXTENSION is used to indicate it.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«dataType» FileTransferData
Datatype
DefaultNO_COMPRESSION
Default Value(NO_COMPRESSION)
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlytrue
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NamecompressionType
Name Expression
Namespace«dataType» FileTransferData
Opposite
Owner«dataType» FileTransferData
Owning Association
Owning Template Parameter
Qualified NameSID Models::Common Domain UNUSED::UNUSED Packages::TIP Common ABE::Management Job ABE::FileTransferData::compressionType
Stereotyperequired
Template Parameter
TypeCompressionType
Upper1
Upper Value
VisibilityPublic


 fileFormat
Public String fileFormat

Defines the format of the files.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«dataType» FileTransferData
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NamefileFormat
Name Expression
Namespace«dataType» FileTransferData
Opposite
Owner«dataType» FileTransferData
Owning Association
Owning Template Parameter
Qualified NameSID Models::Common Domain UNUSED::UNUSED Packages::TIP Common ABE::Management Job ABE::FileTransferData::fileFormat
Stereotype
Template Parameter
TypeString
Upper1
Upper Value
VisibilityPublic


 fileLocation
Public «baseType» URI fileLocation

URI provided by the requesting OS indicating the rootname of the file(s) to be produced and location of where to place the retrieved file(s).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«dataType» FileTransferData
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlytrue
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NamefileLocation
Name Expression
Namespace«dataType» FileTransferData
Opposite
Owner«dataType» FileTransferData
Owning Association
Owning Template Parameter
Qualified NameSID Models::Common Domain UNUSED::UNUSED Packages::TIP Common ABE::Management Job ABE::FileTransferData::fileLocation
Stereotyperequired
Template Parameter
Type«baseType» URI
Upper1
Upper Value
VisibilityPublic


 packingType
Public PackingType packingType

The type of packing to apply to all the file(s) generated from the same request.

Default behavior (when request parameter is omitted) is NO_ PACKING.

Implementation of this file processing instruction by the Target OS is optional, and any incompatible request shall be handled with the appropriate exception. Vendor extension of this attribute is permitted, the value EXTENSION is used to indicate it.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«dataType» FileTransferData
Datatype
DefaultNO_PACKING
Default Value(NO_PACKING)
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlytrue
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NamepackingType
Name Expression
Namespace«dataType» FileTransferData
Opposite
Owner«dataType» FileTransferData
Owning Association
Owning Template Parameter
Qualified NameSID Models::Common Domain UNUSED::UNUSED Packages::TIP Common ABE::Management Job ABE::FileTransferData::packingType
Stereotyperequired
Template Parameter
TypePackingType
Upper1
Upper Value
VisibilityPublic


 retentionPeriod
Public «baseType» Duration retentionPeriod

The maximum duration the files produced by this job will be retained on the producing OS.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«dataType» FileTransferData
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlytrue
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NameretentionPeriod
Name Expression
Namespace«dataType» FileTransferData
Opposite
Owner«dataType» FileTransferData
Owning Association
Owning Template Parameter
Qualified NameSID Models::Common Domain UNUSED::UNUSED Packages::TIP Common ABE::Management Job ABE::FileTransferData::retentionPeriod
Stereotyperequired
Template Parameter
Type«baseType» Duration
Upper1
Upper Value
VisibilityPublic