com.sap.mdm.blobs
Interface ImageBlobRecord

All Superinterfaces:
BinaryBlobRecord, BlobRecord, Cloneable, Record, RepositoryItem

public interface ImageBlobRecord
extends BinaryBlobRecord

An interface representing an image record.

The follow values are required to create an image record.

The following values are optional.

The following values are optional. They are reset when the thumbnail is re-generated for the image record.

The following values are set automatically.


Nested Class Summary
static class ImageBlobRecord.Cropping
          Enumerations for image cropping.
static class ImageBlobRecord.Format
          Enumerations for image format.
static class ImageBlobRecord.Rotation
          Enumerations for image rotation.
 
Nested classes inherited from class com.sap.mdm.data.Record
Record.CheckoutStatus, Record.MatrixType, Record.ModificationStatus
 
Method Summary
 MdmValue getCrcOfOriginal()
          Returns the CRC (cyclic redundancy check) of the image.
 MdmValue getCropping()
          Returns the image cropping.
 MdmValue getFormat()
          Returns the image format, BMP, GIF, JPG, etc.
 MdmValue getHasClipping()
          Returns whether the image has clipping path.
 MdmValue getHasThumbnail()
          Returns whether the blob has a thumbnail.
 MdmValue getHeight()
          Sets the image height.
 MdmValue getIsVector()
          Returns whether the image is in vector form.
 MdmValue getResolution()
          Returns the image resolution.
 MdmValue getRotation()
          Returns the image rotation.
 MdmValue getWidth()
          Returns the image width.
 void setCrcOfOriginal(int crcOfOriginal)
          Sets the CRC (cyclic redundancy check) of the image (optional).
 void setCrcOfOriginal(MdmValue crcOfOriginal)
          Sets the CRC (cyclic redundancy check) of the image (optional).
 void setCropping(int cropping)
          Sets the image cropping (optional).
 void setCropping(MdmValue cropping)
          Sets the image cropping (optional).
 void setFormat(int format)
          Sets the image format, BMP, GIF, JPG, etc (optional).
 void setFormat(MdmValue format)
          Sets the image format, BMP, GIF, JPG, etc (optional).
 void setHasClipping(boolean clipping)
          Sets whether the image has clipping path (optional).
 void setHasClipping(MdmValue clipping)
          Sets whether the image has clipping path (optional).
 void setHasThumbnail(boolean hasThumbnail)
          Sets whether the blob has a thumbnail (optional).
 void setHasThumbnail(MdmValue hasThumbnail)
          Sets whether the blob has a thumbnail (optional).
 void setHeight(int height)
          Sets the image height (optional).
 void setHeight(MdmValue height)
          Sets the image height (optional).
 void setIsVector(boolean isVector)
          Sets whether the image is in vector form (optional).
 void setIsVector(MdmValue isVector)
          Sets whether the image is in vector form (optional).
 void setResolution(int resolution)
          Sets the image resolution (optional).
 void setResolution(MdmValue resolution)
          Sets the image resolution (optional).
 void setRotation(int rotation)
          Sets the image rotation (optional).
 void setRotation(MdmValue rotation)
          Sets the image rotation (optional).
 void setThumbnail(BinaryValue thumbnail)
          Sets the specified thumbnail image for the image record (optional).
 void setWidth(int width)
          Sets the image width (optional).
 void setWidth(MdmValue width)
          Sets the image width (optional).
 
Methods inherited from interface com.sap.mdm.blobs.BinaryBlobRecord
getBinary, getDataLocationId, getHasOriginal, getName, getOriginalName, getSource, setBinary, setBinary, setDataLocationId, setHasOriginal, setHasOriginal, setName, setName, setOriginalName, setOriginalName, setSource
 
Methods inherited from interface com.sap.mdm.blobs.BlobRecord
getCode, getDataGroupId, getDataSize, getDescription, setCode, setDataGroupId, setDataSize, setDataSize, setDescription, setDescription
 
Methods inherited from interface com.sap.mdm.data.Record
clone, containsAttribute, containsField, findLookupRecords, getAttributes, getAttributeValue, getChangeStamp, getCheckoutStatus, getDefaultRegionCode, getDisplayValue, getFields, getFieldValue, getId, getLookupDisplayValue, getMatrixType, getMetadata, getModificationStatus, getMultiregionFieldValue, getReverseLookupRecords, getReverseLookups, getTable, getTupleDisplayValue, hasFieldValue, isInWorkflow, isProtected, isQualifiedField, isTaxonomyField, setAttributeValue, setFieldValue, setMatrixType, toString, toString, toString, toString
 

Method Detail

getHasThumbnail

public MdmValue getHasThumbnail()
Returns whether the blob has a thumbnail.

Returns:
true if it has a thumbnail, otherwise false

setHasThumbnail

public void setHasThumbnail(MdmValue hasThumbnail)
                     throws IllegalArgumentException,
                            MdmValueTypeException
Sets whether the blob has a thumbnail (optional). It is automatically set.

Parameters:
hasThumbnail - true if it has a thumbnail, otherwise false
Throws:
IllegalArgumentException
MdmValueTypeException

setHasThumbnail

public void setHasThumbnail(boolean hasThumbnail)
Sets whether the blob has a thumbnail (optional). It is automatically set.

Parameters:
hasThumbnail - true if it has a thumbnail, otherwise false
Throws:
IllegalArgumentException
MdmValueTypeException
Since:
5.5 SP6 Patch 04

getWidth

public MdmValue getWidth()
Returns the image width.

Returns:
a width

setWidth

public void setWidth(MdmValue width)
              throws IllegalArgumentException,
                     MdmValueTypeException
Sets the image width (optional).

Parameters:
width - a width
Throws:
IllegalArgumentException
MdmValueTypeException

setWidth

public void setWidth(int width)
Sets the image width (optional).

Parameters:
width - a width
Throws:
IllegalArgumentException
MdmValueTypeException
Since:
5.5 SP6 Patch 04

getHeight

public MdmValue getHeight()
Sets the image height.

Returns:
a height

setHeight

public void setHeight(MdmValue height)
               throws IllegalArgumentException,
                      MdmValueTypeException
Sets the image height (optional).

Parameters:
height - a height
Throws:
IllegalArgumentException
MdmValueTypeException

setHeight

public void setHeight(int height)
Sets the image height (optional).

Parameters:
height - a height
Throws:
IllegalArgumentException
MdmValueTypeException
Since:
5.5 SP6 Patch 04

getFormat

public MdmValue getFormat()
Returns the image format, BMP, GIF, JPG, etc.

Returns:
an image format

setFormat

public void setFormat(MdmValue format)
               throws IllegalArgumentException,
                      MdmValueTypeException
Sets the image format, BMP, GIF, JPG, etc (optional).

Parameters:
format - an image format
Throws:
IllegalArgumentException
MdmValueTypeException

setFormat

public void setFormat(int format)
Sets the image format, BMP, GIF, JPG, etc (optional).

Parameters:
format - an image format
Throws:
IllegalArgumentException
MdmValueTypeException
Since:
5.5 SP6 Patch 04

getRotation

public MdmValue getRotation()
Returns the image rotation.

Returns:
an image rotation

setRotation

public void setRotation(MdmValue rotation)
                 throws IllegalArgumentException,
                        MdmValueTypeException
Sets the image rotation (optional).

Parameters:
rotation - an image rotation
Throws:
IllegalArgumentException
MdmValueTypeException

setRotation

public void setRotation(int rotation)
Sets the image rotation (optional).

Parameters:
rotation - an image rotation
Throws:
IllegalArgumentException
MdmValueTypeException
Since:
5.5 SP6 Patch 04

getIsVector

public MdmValue getIsVector()
Returns whether the image is in vector form.

Returns:
true if the image is in vector form, otherwise false

setIsVector

public void setIsVector(MdmValue isVector)
                 throws IllegalArgumentException,
                        MdmValueTypeException
Sets whether the image is in vector form (optional).

Parameters:
isVector - true if the image is in vector form, otherwise false
Throws:
IllegalArgumentException
MdmValueTypeException

setIsVector

public void setIsVector(boolean isVector)
Sets whether the image is in vector form (optional).

Parameters:
isVector - true if the image is in vector form, otherwise false
Throws:
IllegalArgumentException
MdmValueTypeException
Since:
5.5 SP6 Patch 04

getHasClipping

public MdmValue getHasClipping()
Returns whether the image has clipping path.

Returns:
true if the image has clipping path, otherwise false

setHasClipping

public void setHasClipping(MdmValue clipping)
                    throws IllegalArgumentException,
                           MdmValueTypeException
Sets whether the image has clipping path (optional).

Parameters:
clipping - true if the image has clipping path, otherwise false
Throws:
IllegalArgumentException
MdmValueTypeException

setHasClipping

public void setHasClipping(boolean clipping)
Sets whether the image has clipping path (optional).

Parameters:
clipping - true if the image has clipping path, otherwise false
Throws:
IllegalArgumentException
MdmValueTypeException
Since:
5.5 SP6 Patch 04

getResolution

public MdmValue getResolution()
Returns the image resolution.

Returns:
an image resolution

setResolution

public void setResolution(MdmValue resolution)
                   throws IllegalArgumentException,
                          MdmValueTypeException
Sets the image resolution (optional).

Parameters:
resolution - an image resolution
Throws:
IllegalArgumentException
MdmValueTypeException

setResolution

public void setResolution(int resolution)
Sets the image resolution (optional).

Parameters:
resolution - an image resolution
Throws:
IllegalArgumentException
MdmValueTypeException
Since:
5.5 SP6 Patch 04

getCrcOfOriginal

public MdmValue getCrcOfOriginal()
Returns the CRC (cyclic redundancy check) of the image.

Returns:
a CRC value

setCrcOfOriginal

public void setCrcOfOriginal(MdmValue crcOfOriginal)
                      throws IllegalArgumentException,
                             MdmValueTypeException
Sets the CRC (cyclic redundancy check) of the image (optional). It is automatically set.

Parameters:
crcOfOriginal - a CRC value
Throws:
IllegalArgumentException
MdmValueTypeException

setCrcOfOriginal

public void setCrcOfOriginal(int crcOfOriginal)
Sets the CRC (cyclic redundancy check) of the image (optional). It is automatically set.

Parameters:
crcOfOriginal - a CRC value
Throws:
IllegalArgumentException
MdmValueTypeException
Since:
5.5 SP6 Patch 04

getCropping

public MdmValue getCropping()
Returns the image cropping.

Returns:
an image cropping

setCropping

public void setCropping(MdmValue cropping)
                 throws IllegalArgumentException,
                        MdmValueTypeException
Sets the image cropping (optional).

Parameters:
cropping - an image cropping
Throws:
IllegalArgumentException
MdmValueTypeException

setCropping

public void setCropping(int cropping)
Sets the image cropping (optional).

Parameters:
cropping - an image cropping
Throws:
IllegalArgumentException
MdmValueTypeException
Since:
5.5 SP6 Patch 04

setThumbnail

public void setThumbnail(BinaryValue thumbnail)
                  throws IllegalArgumentException,
                         MdmValueTypeException
Sets the specified thumbnail image for the image record (optional).

Note: can be used only when creating an image record.

Parameters:
thumbnail - a JPEG/JIFF image of maximum size 2MB
Throws:
IllegalArgumentException - if the parameter value is invalid
MdmValueTypeException - if there is a mismatch between parameter type and value
Since:
7.1 SP9


Copyright 2004-2007 by SAP AG. All Rights Reserved.

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies (SAP Group) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.