org.jmythapi.protocol.response
Interface IRecorderChannelPrefixStatus

All Superinterfaces:

Cloneable, IPropertyAware<IRecorderChannelPrefixStatus.Props>, IVersionable

All Known Implementing Classes:

RecorderChannelPrefixStatus

public interface IRecorderChannelPrefixStatus
extends IVersionable, IPropertyAware<IRecorderChannelPrefixStatus.Props>

An interface to check if a channel-number prefix matches.

This interface represents the response of an IRecorder.checkChannelPrefix request.
This interface is property-aware. See the properties-list for all properties of this interface.

A response example:

<0>IS_PREFIX_MATCH: true | <1>IS_COMPLETE_MATCH: true | <2>IS_EXTRA_CHAR_USEFUL: false | <3>NEEDED_SPACER: X

See Also:

IRecorder.checkChannelPrefix(String), QUERY_RECORDER_CHECK_CHANNEL_PREFIX

Nested Class Summary

static class

IRecorderChannelPrefixStatus.Props The properties of an IRecorderChannelPrefixStatus response.

Method Summary

String	getNeededSpacer() Gets the first matching spacer, if a spacer whould be needed for the prefix to match a channel.
Boolean	isCompleteMatch() Checks if the prefix fully matches a channel number.
Boolean	isExtraCharUseful() Checks if an additional prefix char chould reduce the number of matching channels.
Boolean	isPrefixMatch() Checks if the prefix matches at least one channel number.

Methods inherited from interface org.jmythapi.IVersionable

getVersionNr

Methods inherited from interface org.jmythapi.IPropertyAware

getProperties, getProperty, getPropertyClass, getPropertyCount, getPropertyIndex, getPropertyMap, getPropertyValue, getPropertyValue, getPropertyValueObject, getPropertyValues, setPropertyValue, setPropertyValue, setPropertyValueObject

Method Detail

isPrefixMatch

Boolean isPrefixMatch()

Checks if the prefix matches at least one channel number.

Returns:

true if there are channels with channel numbers starting with the prefix.

isCompleteMatch

Boolean isCompleteMatch()

Checks if the prefix fully matches a channel number.

Returns:

true if a complete channel number is matched by the prefix.

isExtraCharUseful

Boolean isExtraCharUseful()

Checks if an additional prefix char chould reduce the number of matching channels.

Returns:

true if an additional prefix would reduce the number of matching channels.

getNeededSpacer

String getNeededSpacer()

Gets the first matching spacer, if a spacer whould be needed for the prefix to match a channel.

Returns:

the first matching spacer.