com.wewebu.service.rendition

Interface OwRenditionService

All Known Subinterfaces:

OwConfigurableRenditionService

All Known Implementing Classes:

OwAbstractRenditionService, OwNoRenditionService, OwSymbolicRenditionService

public interface OwRenditionService

Interface for Rendition capability handling.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com

Since:

4.2.0.0

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canCreateRendition(OwObject obj, String type) Capability check for creation of rendition.
void	createRendition(OwObject obj, String type) Trigger a generation of a Rendition for specific object. Before calling this method, verify that capability is available through canCreateRendition(OwObject, String).
List<String>	getRenditionMimeType(OwObject obj, String type) Return the MIME type of rendition, for specific type.
InputStream	getRenditionStream(OwObject obj, String type) Retrieve the stream for specific type and object.
boolean	hasRendition(OwObject obj, String type) Has Rendition representation for such object.

Method Detail

getRenditionStream

InputStream getRenditionStream(OwObject obj,
                             String type)
                               throws IOException,
                                      OwException

Retrieve the stream for specific type and object.

Parameters:

obj - OwObject from whom a rendition is provided

type - String MIME or Rendition type

Returns:

InputStream of rendition representation

Throws:

IOException - if could not access/retrieve stream

OwException - in other cases not matching IO problems

getRenditionMimeType

List<String> getRenditionMimeType(OwObject obj,
                                String type)
                                  throws OwException

Return the MIME type of rendition, for specific type.

Parameters:

obj - OwObject from which rendition are requested

type - String of Rendition

Returns:

List of possible MIME types

Throws:

OwException

hasRendition

boolean hasRendition(OwObject obj,
                   String type)

Has Rendition representation for such object.

Parameters:

obj - OwObject

type - String

Returns:

boolean true if renditions are available for object

createRendition

void createRendition(OwObject obj,
                   String type)
                     throws OwException

Trigger a generation of a Rendition for specific object.
Before calling this method, verify that capability is available through canCreateRendition(OwObject, String).

Parameters:

obj - OwObject

type - String

Throws:

OwException

canCreateRendition

boolean canCreateRendition(OwObject obj,
                         String type)
                           throws OwException

Capability check for creation of rendition.

Parameters:

obj - OwObject

type - String rendition type or MIME

Returns:

true if a rendition can be created for the given object

Throws:

OwException