com.day.cq.dam.api.s7dam.set

Interface SpinSet

All Superinterfaces:

Adaptable, Resource

Deprecated.

Not for public use - this API will be replaced in a future release

@Deprecated
public interface SpinSet
extends Resource

Represents a Scene7 2D SpinSet

Field Summary

Fields inherited from interface org.apache.sling.api.resource.Resource

RESOURCE_TYPE_NON_EXISTING

Method Summary

Modifier and Type	Method and Description
void	addColumn(Asset[] column) Deprecated. Adds column to the set.
void	addRow(Asset[] row) Deprecated. Adds row to the Set.
Asset	getAsset(int row, int column) Deprecated. Returns the asset at specified index in the matrix
Asset[][]	getAssets() Deprecated. Returns the 2D array of assets which consists of spin set.
int	getColumnCount() Deprecated. Returns the number of columns in 2D spin set
int	getRowCount() Deprecated. Returns the number of rows in 2D spin set
boolean	isValidMemberType(Asset asset) Deprecated. Checks if the given asset is valid member type of Media Set
void	removeAssets() Deprecated. Removes all the assets from set
void	removeColumn(int column) Deprecated. Removes the specified column from the set.
void	removeRow(int row) Deprecated. Removes the specified row from the set.
void	setAsset(Asset asset, int row, int column) Deprecated. Set the given asset at specified position in matrix.
void	setAssets(Asset[][] assets) Deprecated. Add the matrix of assets

Methods inherited from interface org.apache.sling.api.resource.Resource

getChild, getChildren, getName, getParent, getPath, getResourceMetadata, getResourceResolver, getResourceSuperType, getResourceType, getValueMap, hasChildren, isResourceType, listChildren

Methods inherited from interface org.apache.sling.api.adapter.Adaptable

adaptTo

Method Detail

setAssets

void setAssets(Asset[][] assets)

Deprecated.

Add the matrix of assets

Parameters:

assets - The 2D matrix consisting of assets

Throws:

java.lang.IllegalArgumentException - if null array is passed.

setAsset

void setAsset(Asset asset,
              int row,
              int column)

Deprecated.

Set the given asset at specified position in matrix.

Parameters:

asset - Asset to be added.

row - Row at which asset needs to be added.

column - Column at which asset needs to be added.

Throws:

java.lang.IllegalArgumentException - if invalid value is passed for row or column

removeAssets

void removeAssets()

Deprecated.

Removes all the assets from set

removeRow

void removeRow(int row)

Deprecated.

Removes the specified row from the set. 0 th index is the first row.

Parameters:

row - Index of the row to be removed

Throws:

java.lang.IllegalArgumentException - if invalid value is passed for row.

removeColumn

void removeColumn(int column)

Deprecated.

Removes the specified column from the set. 0th index is the first column

Parameters:

column - Index of the column to be removed.

Throws:

java.lang.IllegalArgumentException - if invalid value is passed for column.

getAsset

Asset getAsset(int row,
               int column)

Deprecated.

Returns the asset at specified index in the matrix

Parameters:

row - The row index.

column - The column index

Returns:

Asset at specified column, null if it cannot find row.

Throws:

java.lang.IllegalArgumentException - if invalid value is passed for row or column.

getRowCount

int getRowCount()

Deprecated.

Returns the number of rows in 2D spin set

Returns:

Number of rows

getColumnCount

int getColumnCount()

Deprecated.

Returns the number of columns in 2D spin set

Returns:

Number of columns

getAssets

Asset[][] getAssets()

Deprecated.

Returns the 2D array of assets which consists of spin set.

Returns:

The array of assets.

addRow

void addRow(Asset[] row)

Deprecated.

Adds row to the Set.

Parameters:

row - Array containing row to be added.

Throws:

java.lang.IllegalArgumentException - if the dimension of row does not match with existing matrix

addColumn

void addColumn(Asset[] column)

Deprecated.

Adds column to the set.

Parameters:

column - Array containing column to be added.

Throws:

java.lang.IllegalArgumentException - if the dimension of column does not match with existing matrix.

isValidMemberType

boolean isValidMemberType(Asset asset)

Deprecated.

Checks if the given asset is valid member type of Media Set

Parameters:

asset - The asset whose type needs to be checked for membership

Returns:

True if asset type is valid for set, false otherwise.