com.openkm.sdk4j.definition

Interface BaseStamp

All Known Implementing Classes:

OKMWebservices, StampImpl

public interface BaseStamp

The interface Base stamp.

Method Summary

Modifier and Type	Method and Description
StampImageSize	calculateFlyImageDimensions(String uuid, long imgToStampWidth, long imgToStampHeight, long floatingImageWidth, long floatingImageHeight, int pageNumber) Calculate fly image dimensions stamp image size.
StampCoordinates	calculateStampCoordinates(long imgToStampWidth, long imgToStampHeight, long floatingDivWidth, long floatingDivHeight, String exprX, String exprY, String stampType, String stampAlign) Calculate stamp coordinates stamp coordinates.
StampExpressions	calculateStampExpressions(long imgToStampWidth, long imgToStampHeight, long posX, long posY) Calculate stamp expressions stamp expressions.
List<StampItem>	getAllStamps() Gets all stamps.
StampPersonalImage	getPersonalStampImage(String uuid, String imageUuid, long id) Gets personal stamp image.
List<Document>	getPersonalStamps() Gets personal stamps.
StampBarcode	getStampBarcodeByPk(long id, String uuid) Gets stamp barcode by pk.
StampImage	getStampImageByPk(long id, String uuid) Gets stamp image by pk.
StampText	getStampTextByPk(long id, String uuid) Gets stamp text by pk.
void	stampBarcode(String uuid, long id) Stamp barcode.
void	stampImage(String uuid, long id) Stamp image.
void	stampImageCustom(String uuid, long stampImageId, String exprX, String exprY, String range, double ratio, InputStream is) Stamp image custom.
void	stampImageManually(String uuid, long id, String exprX, String exprY, String range, String personalStampUuid) Stamp image manually.
void	stampText(String uuid, long id) Stamp text.
void	stampTextCustom(String uuid, long stampTextId, String text, String exprX, String exprY, String range) Stamp text custom.

Method Detail

getAllStamps

List<StampItem> getAllStamps()
                      throws AccessDeniedException,
                             RepositoryException,
                             DatabaseException,
                             PathNotFoundException,
                             WebserviceException,
                             UnknownException,
                             PrincipalAdapterException

Gets all stamps.

Returns:

the all stamps

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

PrincipalAdapterException - the principal adapter exception

getStampTextByPk

StampText getStampTextByPk(long id,
                           String uuid)
                    throws AccessDeniedException,
                           RepositoryException,
                           DatabaseException,
                           PathNotFoundException,
                           WebserviceException,
                           UnknownException,
                           PrincipalAdapterException

Gets stamp text by pk.

Parameters:

id - the id

uuid - the uuid

Returns:

the stamp text by pk

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

PrincipalAdapterException - the principal adapter exception

getStampImageByPk

StampImage getStampImageByPk(long id,
                             String uuid)
                      throws AccessDeniedException,
                             RepositoryException,
                             DatabaseException,
                             PathNotFoundException,
                             WebserviceException,
                             UnknownException,
                             PrincipalAdapterException

Gets stamp image by pk.

Parameters:

id - the id

uuid - the uuid

Returns:

the stamp image by pk

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

PrincipalAdapterException - the principal adapter exception

getStampBarcodeByPk

StampBarcode getStampBarcodeByPk(long id,
                                 String uuid)
                          throws AccessDeniedException,
                                 RepositoryException,
                                 DatabaseException,
                                 PathNotFoundException,
                                 WebserviceException,
                                 UnknownException,
                                 PrincipalAdapterException

Gets stamp barcode by pk.

Parameters:

id - the id

uuid - the uuid

Returns:

the stamp image by pk

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

PrincipalAdapterException - the principal adapter exception

calculateStampCoordinates

StampCoordinates calculateStampCoordinates(long imgToStampWidth,
                                           long imgToStampHeight,
                                           long floatingDivWidth,
                                           long floatingDivHeight,
                                           String exprX,
                                           String exprY,
                                           String stampType,
                                           String stampAlign)
                                    throws AccessDeniedException,
                                           RepositoryException,
                                           DatabaseException,
                                           PathNotFoundException,
                                           WebserviceException,
                                           UnknownException,
                                           PrincipalAdapterException

Calculate stamp coordinates stamp coordinates.

Parameters:

imgToStampWidth - the img to stamp width

imgToStampHeight - the img to stamp height

floatingDivWidth - the floating div width

floatingDivHeight - the floating div height

exprX - the expr x

exprY - the expr y

stampType - the stamp type

stampAlign - the stamp align

Returns:

the stamp coordinates

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

PrincipalAdapterException - the principal adapter exception

calculateStampExpressions

StampExpressions calculateStampExpressions(long imgToStampWidth,
                                           long imgToStampHeight,
                                           long posX,
                                           long posY)
                                    throws AccessDeniedException,
                                           RepositoryException,
                                           DatabaseException,
                                           PathNotFoundException,
                                           WebserviceException,
                                           UnknownException,
                                           PrincipalAdapterException

Calculate stamp expressions stamp expressions.

Parameters:

imgToStampWidth - the img to stamp width

imgToStampHeight - the img to stamp height

posX - the pos x

posY - the pos y

Returns:

the stamp expressions

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

PrincipalAdapterException - the principal adapter exception

stampText

void stampText(String uuid,
               long id)
        throws AccessDeniedException,
               RepositoryException,
               DatabaseException,
               PathNotFoundException,
               WebserviceException,
               UnknownException,
               PrincipalAdapterException,
               ItemExistsException

Stamp text.

Parameters:

uuid - the uuid

id - the id

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

PrincipalAdapterException - the principal adapter exception

ItemExistsException - the item exists exception

stampImage

void stampImage(String uuid,
                long id)
         throws AccessDeniedException,
                RepositoryException,
                DatabaseException,
                PathNotFoundException,
                WebserviceException,
                UnknownException,
                PrincipalAdapterException,
                ItemExistsException

Stamp image.

Parameters:

uuid - the uuid

id - the id

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

PrincipalAdapterException - the principal adapter exception

ItemExistsException - the item exists exception

stampBarcode

void stampBarcode(String uuid,
                  long id)
           throws AccessDeniedException,
                  RepositoryException,
                  DatabaseException,
                  PathNotFoundException,
                  WebserviceException,
                  UnknownException,
                  PrincipalAdapterException,
                  ItemExistsException

Stamp barcode.

Parameters:

uuid - the uuid

id - the id

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

PrincipalAdapterException - the principal adapter exception

ItemExistsException - the item exists exception

stampImageManually

void stampImageManually(String uuid,
                        long id,
                        String exprX,
                        String exprY,
                        String range,
                        String personalStampUuid)
                 throws AccessDeniedException,
                        RepositoryException,
                        DatabaseException,
                        PathNotFoundException,
                        WebserviceException,
                        UnknownException,
                        PrincipalAdapterException,
                        ItemExistsException

Stamp image manually.

Parameters:

uuid - the uuid

id - the id

exprX - the expr x

exprY - the expr y

range - the range

personalStampUuid - the personal stamp uuid

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

PrincipalAdapterException - the principal adapter exception

ItemExistsException - the item exists exception

stampTextCustom

void stampTextCustom(String uuid,
                     long stampTextId,
                     String text,
                     String exprX,
                     String exprY,
                     String range)
              throws AccessDeniedException,
                     RepositoryException,
                     DatabaseException,
                     WebserviceException,
                     UnknownException,
                     PrincipalAdapterException,
                     ItemExistsException

Stamp text custom.

Parameters:

uuid - the uuid

stampTextId - the stamp text id

text - the text

exprX - the expr x

exprY - the expr y

range - the range*

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

PrincipalAdapterException - the principal adapter exception

ItemExistsException - the item exists exception

stampImageCustom

void stampImageCustom(String uuid,
                      long stampImageId,
                      String exprX,
                      String exprY,
                      String range,
                      double ratio,
                      InputStream is)
               throws AccessDeniedException,
                      RepositoryException,
                      DatabaseException,
                      PathNotFoundException,
                      WebserviceException,
                      UnknownException,
                      PrincipalAdapterException,
                      ItemExistsException

Stamp image custom.

Parameters:

uuid - the uuid

stampImageId - the stamp image id

exprX - the expr x

exprY - the expr y

range - the range

ratio - the ratio

is - the is

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

PrincipalAdapterException - the principal adapter exception

ItemExistsException - the item exists exception

calculateFlyImageDimensions

StampImageSize calculateFlyImageDimensions(String uuid,
                                           long imgToStampWidth,
                                           long imgToStampHeight,
                                           long floatingImageWidth,
                                           long floatingImageHeight,
                                           int pageNumber)
                                    throws AccessDeniedException,
                                           RepositoryException,
                                           DatabaseException,
                                           PathNotFoundException,
                                           WebserviceException,
                                           UnknownException,
                                           PrincipalAdapterException

Calculate fly image dimensions stamp image size.

Parameters:

uuid - the uuid

imgToStampWidth - the img to stamp width

imgToStampHeight - the img to stamp height

floatingImageWidth - the floating image width

floatingImageHeight - the floating image height

pageNumber - the page number

Returns:

the stamp image size

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

PrincipalAdapterException - the principal adapter exception

getPersonalStamps

List<Document> getPersonalStamps()
                          throws AccessDeniedException,
                                 RepositoryException,
                                 DatabaseException,
                                 PathNotFoundException,
                                 WebserviceException,
                                 UnknownException,
                                 PrincipalAdapterException

Gets personal stamps.

Returns:

the personal stamps

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

PrincipalAdapterException - the principal adapter exception

getPersonalStampImage

StampPersonalImage getPersonalStampImage(String uuid,
                                         String imageUuid,
                                         long id)
                                  throws AccessDeniedException,
                                         RepositoryException,
                                         DatabaseException,
                                         PathNotFoundException,
                                         WebserviceException,
                                         UnknownException,
                                         PrincipalAdapterException

Gets personal stamp image.

Parameters:

uuid - the uuid

imageUuid - the image uuid

id - the id

Returns:

the personal stamp image

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

PrincipalAdapterException - the principal adapter exception