ContentBox Core API 1.6.0

contentbox.model.media
Interface IMediaProvider

WEB-INF.cftags.interface
        extended by contentbox.model.media.IMediaProvider
All Known Implementing Classes:
CFContentMediaProvider , ForwardMediaProvider , RelocationMediaProvider

public interface IMediaProvider
extends WEB-INF.cftags.interface

******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | www.ortussolutions.com ******************************************************************************* Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ******************************************************************************* Interface to implement ContentBox Media Providers

Method Summary
 any deliverMedia(any mediaPath)
          Deliver the media
 any getDescription()
          Get the description of this provider
 any getDisplayName()
          Get the display name of a provider
 any getName()
          The internal name of your media provider
 boolean mediaExists(any mediaPath)
          Validate if a media requested exists
 
Methods inherited from class WEB-INF.cftags.interface
None
 

Method Detail

deliverMedia

public any deliverMedia(any mediaPath)
Deliver the media

Parameters:
mediaPath - the media path to deliver back to the user

getDescription

public any getDescription()
Get the description of this provider


getDisplayName

public any getDisplayName()
Get the display name of a provider


getName

public any getName()
The internal name of your media provider


mediaExists

public boolean mediaExists(any mediaPath)
Validate if a media requested exists

Parameters:
mediaPath - the media path to verify if it exists

ContentBox Core API 1.6.0