Inheritance diagram for Com::Vmware::Content::Library::ItemModel:

Avaliable Methods
public method	get_last_sync_time ()

public method	set_type ()

public method	get_cached ()

public method	set_creation_time ()

public method	get_id ()

public method	get_content_version ()

public method	set_name ()

public method	set_source_id ()

public method	set_size ()

public method	get_last_modified_time ()

public method	get_creation_time ()

public method	set_cached ()

public method	get_version ()

public method	new ()

public method	get_size ()

public method	set_last_sync_time ()

public method	set_version ()

public method	set_description ()

public method	get_library_id ()

public method	set_id ()

public method	set_last_modified_time ()

public method	get_description ()

public method	set_metadata_version ()

public method	set_content_version ()

public method	get_metadata_version ()

public method	set_library_id ()

public method	get_type ()

public method	get_source_id ()

public method	get_name ()

Detailed Description

The Com::Vmware::Content::Library::ItemModel class represents a library item that has been stored in a library.

A Com::Vmware::Content::Library::ItemModel represents a single logical unit to be managed within a class Com::Vmware::Content::LibraryModel . Items contain the actual content of a library, and their placement within a library determines policies that affect that content such as publishing.

A library item can have a specified type, indicated with the :attr:Com::Vmware::Content::Library::ItemModel.type field . This property is associated with a Content Library Service plugin that supports specific types and provides additional services. The types available in a specific Content Library Service can be queried using the class Com::Vmware::Content::Type interface . Items of an unknown or unspecified type are treated generically. Because subscribed library catalogs are synchronized as is, subscribing to a remote Content Library Service effectively gives you a library with the functionality of the remote service's type adapter plugins, even if they are not installed locally.

Items can be managed using the class Com::Vmware::Content::Library::Item interface* and, for items in subscribed libraries, the class Com::Vmware::Content::Library::SubscribedItem interface .

Member Function Documentation

public method Com::Vmware::Content::Library::ItemModel::get_cached ( )

Gets the value of 'cached' property.

Return values

cached - The current value of the field. The status that indicates whether the library item is on disk or not. The library item is cached when all its files are on disk. optional#

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::get_content_version ( )

Gets the value of 'content_version' property.

Return values

content_version - The current value of the field. The version of the file content list of this library item. optional#

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::get_creation_time ( )

Gets the value of 'creation_time' property.

Return values

creation_time - The current value of the field. The date and time when this library item was created. optional#

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::get_description ( )

Gets the value of 'description' property.

Return values

description - The current value of the field. A human-readable description for this library item. optional#

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::get_id ( )

Gets the value of 'id' property.

Return values

id	- The current value of the field. A unique identifier for this library item. optional#

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::get_last_modified_time ( )

Gets the value of 'last_modified_time' property.

Return values

last_modified_time - The current value of the field. The date and time when the metadata for this library item was last changed.

This field is affected by changes to the properties or file content of this item. It is not modified by changes to the tags of the item, or by changes to the library which owns this item.

optional#

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::get_last_sync_time ( )

Gets the value of 'last_sync_time' property.

Return values

last_sync_time - The current value of the field. The date and time when this library item was last synchronized.

This field is updated every time a synchronization is triggered on the library item, including when a synchronization is triggered on the library to which this item belongs. The value is null for a library item that belongs to a local library.

optional#

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::get_library_id ( )

Gets the value of 'library_id' property.

Return values

library_id - The current value of the field. The identifier of the class Com::Vmware::Content::LibraryModel to which this item belongs. optional#

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::get_metadata_version ( )

Gets the value of 'metadata_version' property.

Return values

metadata_version - The current value of the field. A version number for the metadata of this library item.

This value is incremented with each change to the metadata of this item. Changes to name, description, and so on will increment this value. The value is not incremented by changes to the content or tags of the item or the library which owns it.

optional#

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::get_name ( )

Gets the value of 'name' property.

Return values

name	- The current value of the field. A human-readable name for this library item.

The name may not be null or an empty string. The name does not have to be unique, even within the same library.

optional#

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::get_size ( )

Gets the value of 'size' property.

Return values

size	- The current value of the field. The library item size, in bytes. The size is the sum of the size used on the storage backing for all the files in the item. When the library item is not cached, the size is 0. optional#

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::get_source_id ( )

Gets the value of 'source_id' property.

Return values

source_id - The current value of the field. The identifier of the class Com::Vmware::Content::Library::ItemModel to which this item is synchronized to if the item belongs to a subscribed library. The value is null* for a library item that belongs to a local library. optional#

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::get_type ( )

Gets the value of 'type' property.

Return values

type	- The current value of the field. An optional type identifier which indicates the type adapter plugin to use.

This field may be set to a non-empty string value that corresponds to an identifier supported by a type adapter plugin present in the Content Library Service. A type adapter plugin, if present for the specified type, can provide additional information and services around the item content. A type adapter can guide the upload process by creating file entries that are in need of being uploaded to complete an item.

The types and plugins supported by the Content Library Service can be queried using the class Com::Vmware::Content::Type interface .

optional#

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::get_version ( )

Gets the value of 'version' property.

Return values

version - The current value of the field. A version number that is updated on metadata changes. This value is used to validate update requests to provide optimistic concurrency of changes.

This value represents a number that is incremented every time library item properties, such as name or description, are changed. It is not incremented by changes to the file content of the library item, including adding or removing files. It is also not affected by tagging the library item.

optional#

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::new ( )

Constructor to initialize the Com::Vmware::Content::Library::ItemModel structure

Return values

Blessed object

Code:

click to view

# Number of lines of code in new: 42
sub new {
   my ($class, %args) = @_;
   $class = ref($class) || $class;
   my $validatorList = [];
      
   my $self = $class->SUPER::new('validator_list' => $validatorList, %args);
   $self->{id} = $args{'id'};
   $self->{library_id} = $args{'library_id'};
   $self->{content_version} = $args{'content_version'};
   $self->{creation_time} = $args{'creation_time'};
   $self->{description} = $args{'description'};
   $self->{last_modified_time} = $args{'last_modified_time'};
   $self->{last_sync_time} = $args{'last_sync_time'};
   $self->{metadata_version} = $args{'metadata_version'};
   $self->{name} = $args{'name'};
   $self->{cached} = $args{'cached'};
   $self->{size} = $args{'size'};
   $self->{type} = $args{'type'};
   $self->{version} = $args{'version'};
   $self->{source_id} = $args{'source_id'};
   $self->set_binding_class('binding_class' => 'Com::Vmware::Content::Library::ItemModel');
   $self->set_binding_name('name' => 'com.vmware.content.library.item_model');
   $self->set_binding_field('key' => 'id', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::StringType()));
   $self->set_binding_field('key' => 'library_id', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::StringType()));
   $self->set_binding_field('key' => 'content_version', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::StringType()));
   $self->set_binding_field('key' => 'creation_time', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::DateTimeType()));
   $self->set_binding_field('key' => 'description', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::StringType()));
   $self->set_binding_field('key' => 'last_modified_time', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::DateTimeType()));
   $self->set_binding_field('key' => 'last_sync_time', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::DateTimeType()));
   $self->set_binding_field('key' => 'metadata_version', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::StringType()));
   $self->set_binding_field('key' => 'name', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::StringType()));
   $self->set_binding_field('key' => 'cached', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::BooleanType()));
   $self->set_binding_field('key' => 'size', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::LongType()));
   $self->set_binding_field('key' => 'type', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::StringType()));
   $self->set_binding_field('key' => 'version', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::StringType()));
   $self->set_binding_field('key' => 'source_id', 'value' => new Com::Vmware::Vapi::Bindings::Type::OptionalType('element_type' => new Com::Vmware::Vapi::Bindings::Type::StringType()));
   bless $self, $class;
   return $self;
}

public method Com::Vmware::Content::Library::ItemModel::set_cached ( )

Sets the given value for 'cached' property.

Parameters

cached - New value for the field. The status that indicates whether the library item is on disk or not. The library item is cached when all its files are on disk.

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::set_content_version ( )

Sets the given value for 'content_version' property.

Parameters

content_version - New value for the field. The version of the file content list of this library item.

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::set_creation_time ( )

Sets the given value for 'creation_time' property.

Parameters

creation_time - New value for the field. The date and time when this library item was created.

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::set_description ( )

Sets the given value for 'description' property.

Parameters

description - New value for the field. A human-readable description for this library item.

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::set_id ( )

Sets the given value for 'id' property.

Parameters

id	- New value for the field. A unique identifier for this library item.

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::set_last_modified_time ( )

Sets the given value for 'last_modified_time' property.

Parameters

last_modified_time - New value for the field. The date and time when the metadata for this library item was last changed.

This field is affected by changes to the properties or file content of this item. It is not modified by changes to the tags of the item, or by changes to the library which owns this item.

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::set_last_sync_time ( )

Sets the given value for 'last_sync_time' property.

Parameters

last_sync_time - New value for the field. The date and time when this library item was last synchronized.

This field is updated every time a synchronization is triggered on the library item, including when a synchronization is triggered on the library to which this item belongs. The value is null for a library item that belongs to a local library.

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::set_library_id ( )

Sets the given value for 'library_id' property.

Parameters

library_id - New value for the field. The identifier of the class Com::Vmware::Content::LibraryModel to which this item belongs.

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::set_metadata_version ( )

Sets the given value for 'metadata_version' property.

Parameters

metadata_version - New value for the field. A version number for the metadata of this library item.

This value is incremented with each change to the metadata of this item. Changes to name, description, and so on will increment this value. The value is not incremented by changes to the content or tags of the item or the library which owns it.

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::set_name ( )

Sets the given value for 'name' property.

Parameters

name	- New value for the field. A human-readable name for this library item.

The name may not be null or an empty string. The name does not have to be unique, even within the same library.

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::set_size ( )

Sets the given value for 'size' property.

Parameters

size	- New value for the field. The library item size, in bytes. The size is the sum of the size used on the storage backing for all the files in the item. When the library item is not cached, the size is 0.

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::set_source_id ( )

Sets the given value for 'source_id' property.

Parameters

source_id - New value for the field. The identifier of the class Com::Vmware::Content::Library::ItemModel to which this item is synchronized to if the item belongs to a subscribed library. The value is null* for a library item that belongs to a local library.

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::set_type ( )

Sets the given value for 'type' property.

Parameters

type	- New value for the field. An optional type identifier which indicates the type adapter plugin to use.

This field may be set to a non-empty string value that corresponds to an identifier supported by a type adapter plugin present in the Content Library Service. A type adapter plugin, if present for the specified type, can provide additional information and services around the item content. A type adapter can guide the upload process by creating file entries that are in need of being uploaded to complete an item.

The types and plugins supported by the Content Library Service can be queried using the class Com::Vmware::Content::Type interface .

Code:

click to view

public method Com::Vmware::Content::Library::ItemModel::set_version ( )

Sets the given value for 'version' property.

Parameters

version - New value for the field. A version number that is updated on metadata changes. This value is used to validate update requests to provide optimistic concurrency of changes.

This value represents a number that is incremented every time library item properties, such as name or description, are changed. It is not incremented by changes to the file content of the library item, including adding or removing files. It is also not affected by tagging the library item.

Code:

click to view

The documentation for this class was generated from the following file:

Com/Vmware/Content/Library/ItemModel.pm

Avaliable Methods

Detailed Description

Member Function Documentation